Google API Common Protos Client - Class JavaSettings (4.8.2)

Reference documentation and code samples for the Google API Common Protos Client class JavaSettings.

Settings for Java client libraries.

Generated from protobuf message google.api.JavaSettings

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ library_package string

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
↳ service_class_names array|Google\Protobuf\Internal\MapField

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
↳ common Google\Api\CommonLanguageSettings

Some settings.

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

Returns
Type Description
string

setLibraryPackage

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

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceClassNames

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
Returns
Type Description
Google\Protobuf\Internal\MapField

setServiceClassNames

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
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCommon

Some settings.

Returns
Type Description
Google\Api\CommonLanguageSettings|null

hasCommon

clearCommon

setCommon

Some settings.

Parameter
Name Description
var Google\Api\CommonLanguageSettings
Returns
Type Description
$this