Class JavaSettings.Builder (2.29.0) 

public static final class JavaSettings.Builder extends GeneratedMessageV3.Builder<JavaSettings.Builder> implements JavaSettingsOrBuilder

Settings for Java client libraries.

Protobuf type google.api.JavaSettings

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public JavaSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
JavaSettings.Builder
Overrides

build()

public JavaSettings build()
Returns
Type Description
JavaSettings

buildPartial()

public JavaSettings buildPartial()
Returns
Type Description
JavaSettings

clear()

public JavaSettings.Builder clear()
Returns
Type Description
JavaSettings.Builder
Overrides

clearCommon()

public JavaSettings.Builder clearCommon()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type Description
JavaSettings.Builder

clearField(Descriptors.FieldDescriptor field)

public JavaSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
JavaSettings.Builder
Overrides

clearLibraryPackage()

public JavaSettings.Builder clearLibraryPackage()

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
JavaSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public JavaSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
JavaSettings.Builder
Overrides

clearServiceClassNames()

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

clone()

public JavaSettings.Builder clone()
Returns
Type Description
JavaSettings.Builder
Overrides

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

getCommon()

public CommonLanguageSettings getCommon()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type Description
CommonLanguageSettings

The common.

getCommonBuilder()

public CommonLanguageSettings.Builder getCommonBuilder()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type Description
CommonLanguageSettings.Builder

getCommonOrBuilder()

public CommonLanguageSettingsOrBuilder getCommonOrBuilder()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type Description
CommonLanguageSettingsOrBuilder

getDefaultInstanceForType()

public JavaSettings getDefaultInstanceForType()
Returns
Type Description
JavaSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMutableServiceClassNames() (deprecated)

public Map<String,String> getMutableServiceClassNames()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommon(CommonLanguageSettings value)

public JavaSettings.Builder mergeCommon(CommonLanguageSettings value)

Some settings.

.google.api.CommonLanguageSettings common = 3;

Parameter
Name Description
value CommonLanguageSettings
Returns
Type Description
JavaSettings.Builder

mergeFrom(JavaSettings other)

public JavaSettings.Builder mergeFrom(JavaSettings other)
Parameter
Name Description
other JavaSettings
Returns
Type Description
JavaSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public JavaSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JavaSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public JavaSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
JavaSettings.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final JavaSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
JavaSettings.Builder
Overrides

putAllServiceClassNames(Map<String,String> values)

public JavaSettings.Builder putAllServiceClassNames(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
JavaSettings.Builder

putServiceClassNames(String key, String value)

public JavaSettings.Builder putServiceClassNames(String key, String value)

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
value String
Returns
Type Description
JavaSettings.Builder

removeServiceClassNames(String key)

public JavaSettings.Builder removeServiceClassNames(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
JavaSettings.Builder

setCommon(CommonLanguageSettings value)

public JavaSettings.Builder setCommon(CommonLanguageSettings value)

Some settings.

.google.api.CommonLanguageSettings common = 3;

Parameter
Name Description
value CommonLanguageSettings
Returns
Type Description
JavaSettings.Builder

setCommon(CommonLanguageSettings.Builder builderForValue)

public JavaSettings.Builder setCommon(CommonLanguageSettings.Builder builderForValue)

Some settings.

.google.api.CommonLanguageSettings common = 3;

Parameter
Name Description
builderForValue CommonLanguageSettings.Builder
Returns
Type Description
JavaSettings.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public JavaSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
JavaSettings.Builder
Overrides

setLibraryPackage(String value)

public JavaSettings.Builder setLibraryPackage(String value)

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;

Parameter
Name Description
value String

The libraryPackage to set.
Returns
Type Description
JavaSettings.Builder

This builder for chaining.

setLibraryPackageBytes(ByteString value)

public JavaSettings.Builder setLibraryPackageBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for libraryPackage to set.
Returns
Type Description
JavaSettings.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public JavaSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
JavaSettings.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final JavaSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
JavaSettings.Builder
Overrides