Documentation

JavaSettings extends Message
in package

Settings for Java client libraries.

Generated from protobuf message google.api.JavaSettings

Table of Contents

Properties

$common  : mixed
Some settings.
$library_package  : mixed
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.
$service_class_names  : mixed
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.

Methods

__construct()  : mixed
Constructor.
clearCommon()  : mixed
getCommon()  : CommonLanguageSettings|null
Some settings.
getLibraryPackage()  : 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.
getServiceClassNames()  : 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.
hasCommon()  : mixed
setCommon()  : $this
Some settings.
setLibraryPackage()  : $this
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.
setServiceClassNames()  : $this
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.

Properties

$common

Some settings.

protected mixed $common = null

Generated from protobuf field .google.api.CommonLanguageSettings common = 3 [json_name = "common"];

$library_package

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.

protected mixed $library_package = ''

Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1

Generated from protobuf field string library_package = 1 [json_name = "libraryPackage"];

$service_class_names

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.

private mixed $service_class_names

Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin

Generated from protobuf field map<string, string> service_class_names = 2 [json_name = "serviceClassNames"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $library_package
      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
@type array|\Google\Protobuf\Internal\MapField $service_class_names
      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
@type \Google\Api\CommonLanguageSettings $common
      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.

public getLibraryPackage() : string

Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1

Generated from protobuf field string library_package = 1 [json_name = "libraryPackage"];

Return values
string

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.

public getServiceClassNames() : MapField

Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin

Generated from protobuf field map<string, string> service_class_names = 2 [json_name = "serviceClassNames"];

Return values
MapField

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.

public setLibraryPackage(string $var) : $this

Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1

Generated from protobuf field string library_package = 1 [json_name = "libraryPackage"];

Parameters
$var : string
Return values
$this

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.

public setServiceClassNames(array<string|int, mixed>|MapField $var) : $this

Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin

Generated from protobuf field map<string, string> service_class_names = 2 [json_name = "serviceClassNames"];

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results