Interface JavaSettingsOrBuilder (2.24.0)

Version 2.24.0

• 2.48.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface JavaSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsServiceClassNames(String key)

public abstract 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 abstract CommonLanguageSettings getCommon()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type	Description
CommonLanguageSettings	The common.

getCommonOrBuilder()

public abstract CommonLanguageSettingsOrBuilder getCommonOrBuilder()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type	Description
CommonLanguageSettingsOrBuilder

getLibraryPackage()

public abstract 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 abstract 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.

getServiceClassNames()

public abstract Map<String,String> getServiceClassNames()

Use #getServiceClassNamesMap() instead.

Returns
Type	Description
Map<String,String>

getServiceClassNamesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasCommon()

Some settings.

.google.api.CommonLanguageSettings common = 3;

Returns
Type	Description
boolean	Whether the common field is set.