Class JavaSettings (2.24.0)

public final class JavaSettings extends GeneratedMessageV3 implements JavaSettingsOrBuilder

Settings for Java client libraries.

Protobuf type google.api.JavaSettings

Static Fields

COMMON_FIELD_NUMBER

public static final int COMMON_FIELD_NUMBER
Field Value
TypeDescription
int

LIBRARY_PACKAGE_FIELD_NUMBER

public static final int LIBRARY_PACKAGE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_CLASS_NAMES_FIELD_NUMBER

public static final int SERVICE_CLASS_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static JavaSettings getDefaultInstance()
Returns
TypeDescription
JavaSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static JavaSettings.Builder newBuilder()
Returns
TypeDescription
JavaSettings.Builder

newBuilder(JavaSettings prototype)

public static JavaSettings.Builder newBuilder(JavaSettings prototype)
Parameter
NameDescription
prototypeJavaSettings
Returns
TypeDescription
JavaSettings.Builder

parseDelimitedFrom(InputStream input)

public static JavaSettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static JavaSettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static JavaSettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static JavaSettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static JavaSettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static JavaSettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JavaSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<JavaSettings> parser()
Returns
TypeDescription
Parser<JavaSettings>

Methods

containsServiceClassNames(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCommon()

public CommonLanguageSettings getCommon()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
TypeDescription
CommonLanguageSettings

The common.

getCommonOrBuilder()

public CommonLanguageSettingsOrBuilder getCommonOrBuilder()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
TypeDescription
CommonLanguageSettingsOrBuilder

getDefaultInstanceForType()

public JavaSettings getDefaultInstanceForType()
Returns
TypeDescription
JavaSettings

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;

Returns
TypeDescription
String

The libraryPackage.

getLibraryPackageBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for libraryPackage.

getParserForType()

public Parser<JavaSettings> getParserForType()
Returns
TypeDescription
Parser<JavaSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceClassNames()

public Map<String,String> getServiceClassNames()
Returns
TypeDescription
Map<String,String>

getServiceClassNamesCount()

public int getServiceClassNamesCount()

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
Map<String,String>

getServiceClassNamesOrDefault(String key, String defaultValue)

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;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getServiceClassNamesOrThrow(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

hasCommon()

public boolean hasCommon()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
TypeDescription
boolean

Whether the common field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public JavaSettings.Builder newBuilderForType()
Returns
TypeDescription
JavaSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected JavaSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
JavaSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public JavaSettings.Builder toBuilder()
Returns
TypeDescription
JavaSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException