Package com.google.api

Class JavaSettings

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<JavaSettings,JavaSettings.Builder>
com.google.api.JavaSettings
All Implemented Interfaces:
JavaSettingsOrBuilder, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
public final class JavaSettings extends com.google.protobuf.GeneratedMessageLite<JavaSettings,JavaSettings.Builder> implements JavaSettingsOrBuilder
 Settings for Java client libraries.
Protobuf type google.api.JavaSettings

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    JavaSettings.Builder
    Settings for Java client libraries.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COMMON_FIELD_NUMBER
     
    static final int
    LIBRARY_PACKAGE_FIELD_NUMBER
     
    static final int
    SERVICE_CLASS_NAMES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsServiceClassNames(String key)
    Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    CommonLanguageSettings
    getCommon()
    Some settings.
    static JavaSettings
    getDefaultInstance()
     
    String
    getLibraryPackage()
    The package name to use in Java.
    com.google.protobuf.ByteString
    getLibraryPackageBytes()
    The package name to use in Java.
    Map<String,String>
    getServiceClassNames()
    Deprecated.
    int
    getServiceClassNamesCount()
    Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
    Map<String,String>
    getServiceClassNamesMap()
    Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
    String
    getServiceClassNamesOrDefault(String key, String defaultValue)
    Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
    String
    getServiceClassNamesOrThrow(String key)
    Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
    boolean
    hasCommon()
    Some settings.
    static JavaSettings.Builder
    newBuilder()
     
    static JavaSettings.Builder
    newBuilder(JavaSettings prototype)
     
    static JavaSettings
    parseDelimitedFrom(InputStream input)
     
    static JavaSettings
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JavaSettings
    parseFrom(byte[] data)
     
    static JavaSettings
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JavaSettings
    parseFrom(com.google.protobuf.ByteString data)
     
    static JavaSettings
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JavaSettings
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static JavaSettings
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JavaSettings
    parseFrom(InputStream input)
     
    static JavaSettings
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JavaSettings
    parseFrom(ByteBuffer data)
     
    static JavaSettings
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<JavaSettings>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • LIBRARY_PACKAGE_FIELD_NUMBER

      public static final int LIBRARY_PACKAGE_FIELD_NUMBER
      See Also:

    • SERVICE_CLASS_NAMES_FIELD_NUMBER

      public static final int SERVICE_CLASS_NAMES_FIELD_NUMBER
      See Also:

    • COMMON_FIELD_NUMBER

      public static final int COMMON_FIELD_NUMBER
      See Also:

  • Method Details

    • getLibraryPackage

      public String getLibraryPackage()
       The package name to use in Java. Clobbers the java_package option
 set in the protobuf. This should be used **only** by APIs
 who have already set the language_settings.java.package_name" field
 in gapic.yaml. API teams should use the protobuf java_package option
 where possible.

 Example of a YAML configuration::

 publishing:
 java_settings:
 library_package: com.google.cloud.pubsub.v1
      string library_package = 1 [json_name = "libraryPackage"];
      Specified by:
      getLibraryPackage in interface JavaSettingsOrBuilder
      Returns:
      The libraryPackage.

    • getLibraryPackageBytes

      public com.google.protobuf.ByteString getLibraryPackageBytes()
       The package name to use in Java. Clobbers the java_package option
 set in the protobuf. This should be used **only** by APIs
 who have already set the language_settings.java.package_name" field
 in gapic.yaml. API teams should use the protobuf java_package option
 where possible.

 Example of a YAML configuration::

 publishing:
 java_settings:
 library_package: com.google.cloud.pubsub.v1
      string library_package = 1 [json_name = "libraryPackage"];
      Specified by:
      getLibraryPackageBytes in interface JavaSettingsOrBuilder
      Returns:
      The bytes for libraryPackage.

    • getServiceClassNamesCount

      public int getServiceClassNamesCount()
      Description copied from interface: JavaSettingsOrBuilder
       Configure the Java class name to use instead of the service's for its
 corresponding generated GAPIC client. Keys are fully-qualified
 service names as they appear in the protobuf (including the full
 the language_settings.java.interface_names" field in gapic.yaml. API
 teams should otherwise use the service name as it appears in the
 protobuf.

 Example of a YAML configuration::

 publishing:
 java_settings:
 service_class_names:
 - google.pubsub.v1.Publisher: TopicAdmin
 - google.pubsub.v1.Subscriber: SubscriptionAdmin
      map<string, string> service_class_names = 2 [json_name = "serviceClassNames"];
      Specified by:
      getServiceClassNamesCount in interface JavaSettingsOrBuilder

    • containsServiceClassNames

      public boolean containsServiceClassNames(String key)
       Configure the Java class name to use instead of the service's for its
 corresponding generated GAPIC client. Keys are fully-qualified
 service names as they appear in the protobuf (including the full
 the language_settings.java.interface_names" field in gapic.yaml. API
 teams should otherwise use the service name as it appears in the
 protobuf.

 Example of a YAML configuration::

 publishing:
 java_settings:
 service_class_names:
 - google.pubsub.v1.Publisher: TopicAdmin
 - google.pubsub.v1.Subscriber: SubscriptionAdmin
      map<string, string> service_class_names = 2 [json_name = "serviceClassNames"];
      Specified by:
      containsServiceClassNames in interface JavaSettingsOrBuilder

    • getServiceClassNames

      @Deprecated public Map<String,String> getServiceClassNames()
      Deprecated.
      Use getServiceClassNamesMap() instead.
      Specified by:
      getServiceClassNames in interface JavaSettingsOrBuilder

    • getServiceClassNamesMap

      public Map<String,String> getServiceClassNamesMap()
       Configure the Java class name to use instead of the service's for its
 corresponding generated GAPIC client. Keys are fully-qualified
 service names as they appear in the protobuf (including the full
 the language_settings.java.interface_names" field in gapic.yaml. API
 teams should otherwise use the service name as it appears in the
 protobuf.

 Example of a YAML configuration::

 publishing:
 java_settings:
 service_class_names:
 - google.pubsub.v1.Publisher: TopicAdmin
 - google.pubsub.v1.Subscriber: SubscriptionAdmin
      map<string, string> service_class_names = 2 [json_name = "serviceClassNames"];
      Specified by:
      getServiceClassNamesMap in interface JavaSettingsOrBuilder

    • getServiceClassNamesOrDefault

      public String getServiceClassNamesOrDefault(String key, String defaultValue)
       Configure the Java class name to use instead of the service's for its
 corresponding generated GAPIC client. Keys are fully-qualified
 service names as they appear in the protobuf (including the full
 the language_settings.java.interface_names" field in gapic.yaml. API
 teams should otherwise use the service name as it appears in the
 protobuf.

 Example of a YAML configuration::

 publishing:
 java_settings:
 service_class_names:
 - google.pubsub.v1.Publisher: TopicAdmin
 - google.pubsub.v1.Subscriber: SubscriptionAdmin
      map<string, string> service_class_names = 2 [json_name = "serviceClassNames"];
      Specified by:
      getServiceClassNamesOrDefault in interface JavaSettingsOrBuilder

    • getServiceClassNamesOrThrow

      public String getServiceClassNamesOrThrow(String key)
       Configure the Java class name to use instead of the service's for its
 corresponding generated GAPIC client. Keys are fully-qualified
 service names as they appear in the protobuf (including the full
 the language_settings.java.interface_names" field in gapic.yaml. API
 teams should otherwise use the service name as it appears in the
 protobuf.

 Example of a YAML configuration::

 publishing:
 java_settings:
 service_class_names:
 - google.pubsub.v1.Publisher: TopicAdmin
 - google.pubsub.v1.Subscriber: SubscriptionAdmin
      map<string, string> service_class_names = 2 [json_name = "serviceClassNames"];
      Specified by:
      getServiceClassNamesOrThrow in interface JavaSettingsOrBuilder

    • hasCommon

      public boolean hasCommon()
       Some settings.
      .google.api.CommonLanguageSettings common = 3 [json_name = "common"];
      Specified by:
      hasCommon in interface JavaSettingsOrBuilder
      Returns:
      Whether the common field is set.

    • getCommon

      public CommonLanguageSettings getCommon()
       Some settings.
      .google.api.CommonLanguageSettings common = 3 [json_name = "common"];
      Specified by:
      getCommon in interface JavaSettingsOrBuilder
      Returns:
      The common.

    • parseFrom

      public static JavaSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JavaSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JavaSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JavaSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JavaSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JavaSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JavaSettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static JavaSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static JavaSettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static JavaSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static JavaSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static JavaSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static JavaSettings.Builder newBuilder()

    • newBuilder

      public static JavaSettings.Builder newBuilder(JavaSettings prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<JavaSettings,JavaSettings.Builder>

    • getDefaultInstance

      public static JavaSettings getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<JavaSettings> parser()