Package com.google.api

Class JavaSettings

  • All Implemented Interfaces:
    JavaSettingsOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class JavaSettings
extends com.google.protobuf.GeneratedMessageV3
implements JavaSettingsOrBuilder
     Settings for Java client libraries.
    Protobuf type google.api.JavaSettings
    See Also:
    Serialized Form

    • Nested Class Summary

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

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

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

      • Fields inherited from class com.google.protobuf.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsServiceClassNames​(java.lang.String key)
      Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
      boolean equals​(java.lang.Object obj)  
      CommonLanguageSettings getCommon()
      Some settings.
      CommonLanguageSettingsOrBuilder getCommonOrBuilder()
      Some settings.
      static JavaSettings getDefaultInstance()  
      JavaSettings getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getLibraryPackage()
      The package name to use in Java.
      com.google.protobuf.ByteString getLibraryPackageBytes()
      The package name to use in Java.
      com.google.protobuf.Parser<JavaSettings> getParserForType()  
      int getSerializedSize()  
      java.util.Map<java.lang.String,​java.lang.String> getServiceClassNames()
      Deprecated.
      int getServiceClassNamesCount()
      Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
      java.util.Map<java.lang.String,​java.lang.String> getServiceClassNamesMap()
      Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
      java.lang.String getServiceClassNamesOrDefault​(java.lang.String key, java.lang.String defaultValue)
      Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
      java.lang.String getServiceClassNamesOrThrow​(java.lang.String key)
      Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client.
      boolean hasCommon()
      Some settings.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection​(int number)  
      boolean isInitialized()  
      static JavaSettings.Builder newBuilder()  
      static JavaSettings.Builder newBuilder​(JavaSettings prototype)  
      JavaSettings.Builder newBuilderForType()  
      protected JavaSettings.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static JavaSettings parseDelimitedFrom​(java.io.InputStream input)  
      static JavaSettings parseDelimitedFrom​(java.io.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​(java.io.InputStream input)  
      static JavaSettings parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static JavaSettings parseFrom​(java.nio.ByteBuffer data)  
      static JavaSettings parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<JavaSettings> parser()  
      JavaSettings.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType

      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString

      • 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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • LIBRARY_PACKAGE_FIELD_NUMBER

        public static final int LIBRARY_PACKAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_CLASS_NAMES_FIELD_NUMBER

        public static final int SERVICE_CLASS_NAMES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapFieldReflection

        protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection​(int number)
        Overrides:
        internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getLibraryPackage

        public java.lang.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;
        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;
        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;
        Specified by:
        getServiceClassNamesCount in interface JavaSettingsOrBuilder

      • containsServiceClassNames

        public boolean containsServiceClassNames​(java.lang.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;
        Specified by:
        containsServiceClassNames in interface JavaSettingsOrBuilder

      • getServiceClassNamesMap

        public java.util.Map<java.lang.String,​java.lang.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;
        Specified by:
        getServiceClassNamesMap in interface JavaSettingsOrBuilder

      • getServiceClassNamesOrDefault

        public java.lang.String getServiceClassNamesOrDefault​(java.lang.String key,
                                                      java.lang.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;
        Specified by:
        getServiceClassNamesOrDefault in interface JavaSettingsOrBuilder

      • getServiceClassNamesOrThrow

        public java.lang.String getServiceClassNamesOrThrow​(java.lang.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;
        Specified by:
        getServiceClassNamesOrThrow in interface JavaSettingsOrBuilder

      • hasCommon

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

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

      • parseFrom

        public static JavaSettings parseFrom​(java.nio.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​(java.io.InputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static JavaSettings parseDelimitedFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

        public JavaSettings.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public JavaSettings.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected JavaSettings.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static JavaSettings getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<JavaSettings> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage

      • getDefaultInstanceForType

        public JavaSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder