Class JavaSettings (2.38.0) 

public final class JavaSettings extends GeneratedMessageV3 implements JavaSettingsOrBuilder

Settings for Java client libraries.

Protobuf type google.api.JavaSettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > JavaSettings

Static Fields

COMMON_FIELD_NUMBER

public static final int COMMON_FIELD_NUMBER
Field Value
Type Description
int

LIBRARY_PACKAGE_FIELD_NUMBER

public static final int LIBRARY_PACKAGE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_CLASS_NAMES_FIELD_NUMBER

public static final int SERVICE_CLASS_NAMES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static JavaSettings getDefaultInstance()
Returns
Type Description
JavaSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static JavaSettings.Builder newBuilder()
Returns
Type Description
JavaSettings.Builder

newBuilder(JavaSettings prototype)

public static JavaSettings.Builder newBuilder(JavaSettings prototype)
Parameter
Name Description
prototype JavaSettings
Returns
Type Description
JavaSettings.Builder

parseDelimitedFrom(InputStream input)

public static JavaSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
JavaSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JavaSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static JavaSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
JavaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JavaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static JavaSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
JavaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JavaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static JavaSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
JavaSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JavaSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static JavaSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
JavaSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JavaSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static JavaSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
JavaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static JavaSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JavaSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<JavaSettings> parser()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCommon()

public CommonLanguageSettings getCommon()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type Description
CommonLanguageSettings

The common.

getCommonOrBuilder()

public CommonLanguageSettingsOrBuilder getCommonOrBuilder()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type Description
CommonLanguageSettingsOrBuilder

getDefaultInstanceForType()

public JavaSettings getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for libraryPackage.

getParserForType()

public Parser<JavaSettings> getParserForType()
Returns
Type Description
Parser<JavaSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceClassNames() (deprecated)

public Map<String,String> getServiceClassNames()

Use #getServiceClassNamesMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
String

hasCommon()

public boolean hasCommon()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type Description
boolean

Whether the common field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public JavaSettings.Builder newBuilderForType()
Returns
Type Description
JavaSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected JavaSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
JavaSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public JavaSettings.Builder toBuilder()
Returns
Type Description
JavaSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException