root
API
Generated with
root/com.google/com.google.api/com.google.api.client

com.google.api.client

package com.google.api.client

Members list

Type members

Classlikes

sealed abstract class ClientLibraryDestination(val value: Int) extends GeneratedEnum

To where should client libraries be published?

To where should client libraries be published?

Attributes

Companion
object
Source
ClientLibraryDestination.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object GITHUB
trait Recognized
class Unrecognized
object ClientLibraryDestination extends GeneratedEnumCompanion[ClientLibraryDestination]

Attributes

Companion
class
Source
ClientLibraryDestination.scala
Supertypes
trait Sum
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class ClientLibraryOrganization(val value: Int) extends GeneratedEnum

The organization for which the client libraries are being published. Affects the url where generated docs are published, etc.

The organization for which the client libraries are being published. Affects the url where generated docs are published, etc.

Attributes

Companion
object
Source
ClientLibraryOrganization.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object ADS
object CLOUD
object GENERATIVE_AI
object GEO
object PHOTOS
trait Recognized
object SHOPPING
object STREET_VIEW
class Unrecognized
Show all
object ClientLibraryOrganization extends GeneratedEnumCompanion[ClientLibraryOrganization]

Attributes

Companion
class
Source
ClientLibraryOrganization.scala
Supertypes
trait Sum
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ClientLibrarySettings(version: String, launchStage: LaunchStage, restNumericEnums: Boolean, javaSettings: Option[JavaSettings], cppSettings: Option[CppSettings], phpSettings: Option[PhpSettings], pythonSettings: Option[PythonSettings], nodeSettings: Option[NodeSettings], dotnetSettings: Option[DotnetSettings], rubySettings: Option[RubySettings], goSettings: Option[GoSettings], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ClientLibrarySettings]

Details about how and where to publish client libraries.

Details about how and where to publish client libraries.

Value parameters

cppSettings

Settings for C++ client libraries.

dotnetSettings

Settings for .NET client libraries.

goSettings

Settings for Go client libraries.

javaSettings

Settings for legacy Java features, supported in the Service YAML.

launchStage

Launch stage of this version of the API.

nodeSettings

Settings for Node client libraries.

phpSettings

Settings for PHP client libraries.

pythonSettings

Settings for Python client libraries.

restNumericEnums

When using transport=rest, the client request will encode enums as numbers rather than strings.

rubySettings

Settings for Ruby client libraries.

version

Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".

Attributes

Companion
object
Source
ClientLibrarySettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ClientLibrarySettings extends GeneratedMessageCompanion[ClientLibrarySettings]

Attributes

Companion
class
Source
ClientLibrarySettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object ClientProto extends GeneratedFileObject

Attributes

Source
ClientProto.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class CommonLanguageSettings(referenceDocsUri: String, destinations: Seq[ClientLibraryDestination], selectiveGapicGeneration: Option[SelectiveGapicGeneration], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CommonLanguageSettings]

Required information for every language.

Required information for every language.

Value parameters

destinations

The destination where API teams want this client library to be published.

referenceDocsUri

Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest

selectiveGapicGeneration

Configuration for which RPCs should be generated in the GAPIC client.

Attributes

Companion
object
Source
CommonLanguageSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CommonLanguageSettings extends GeneratedMessageCompanion[CommonLanguageSettings]

Attributes

Companion
class
Source
CommonLanguageSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CppSettings(common: Option[CommonLanguageSettings], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CppSettings]

Settings for C++ client libraries.

Settings for C++ client libraries.

Value parameters

common

Some settings.

Attributes

Companion
object
Source
CppSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CppSettings extends GeneratedMessageCompanion[CppSettings]

Attributes

Companion
class
Source
CppSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DotnetSettings(common: Option[CommonLanguageSettings], renamedServices: Map[String, String], renamedResources: Map[String, String], ignoredResources: Seq[String], forcedNamespaceAliases: Seq[String], handwrittenSignatures: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DotnetSettings]

Settings for Dotnet client libraries.

Settings for Dotnet client libraries.

Value parameters

common

Some settings.

forcedNamespaceAliases

Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision

handwrittenSignatures

Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.

ignoredResources

List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"

renamedResources

Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"

renamedServices

Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.

Attributes

Companion
object
Source
DotnetSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DotnetSettings extends GeneratedMessageCompanion[DotnetSettings]

Attributes

Companion
class
Source
DotnetSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GoSettings(common: Option[CommonLanguageSettings], renamedServices: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GoSettings]

Settings for Go client libraries.

Settings for Go client libraries.

Value parameters

common

Some settings.

renamedServices

Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin

Attributes

Companion
object
Source
GoSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GoSettings extends GeneratedMessageCompanion[GoSettings]

Attributes

Companion
class
Source
GoSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
GoSettings.type
final case class JavaSettings(libraryPackage: String, serviceClassNames: Map[String, String], common: Option[CommonLanguageSettings], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[JavaSettings]

Settings for Java client libraries.

Settings for Java client libraries.

Value parameters

common

Some settings.

libraryPackage

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

serviceClassNames

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

Attributes

Companion
object
Source
JavaSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object JavaSettings extends GeneratedMessageCompanion[JavaSettings]

Attributes

Companion
class
Source
JavaSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class MethodSettings(selector: String, longRunning: Option[LongRunning], autoPopulatedFields: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[MethodSettings]

Describes the generator configuration for a method.

Describes the generator configuration for a method.

Value parameters

autoPopulatedFields

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id

longRunning

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes

selector

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options. Example: publishing: method_settings: - selector: google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...

Attributes

Companion
object
Source
MethodSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MethodSettings extends GeneratedMessageCompanion[MethodSettings]

Attributes

Companion
class
Source
MethodSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class NodeSettings(common: Option[CommonLanguageSettings], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[NodeSettings]

Settings for Node client libraries.

Settings for Node client libraries.

Value parameters

common

Some settings.

Attributes

Companion
object
Source
NodeSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NodeSettings extends GeneratedMessageCompanion[NodeSettings]

Attributes

Companion
class
Source
NodeSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class PhpSettings(common: Option[CommonLanguageSettings], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[PhpSettings]

Settings for Php client libraries.

Settings for Php client libraries.

Value parameters

common

Some settings.

Attributes

Companion
object
Source
PhpSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PhpSettings extends GeneratedMessageCompanion[PhpSettings]

Attributes

Companion
class
Source
PhpSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class Publishing(methodSettings: Seq[MethodSettings], newIssueUri: String, documentationUri: String, apiShortName: String, githubLabel: String, codeownerGithubTeams: Seq[String], docTagPrefix: String, organization: ClientLibraryOrganization, librarySettings: Seq[ClientLibrarySettings], protoReferenceDocumentationUri: String, restReferenceDocumentationUri: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Publishing]

This message configures the settings for publishing Google Cloud Client libraries generated from the service config.

This message configures the settings for publishing Google Cloud Client libraries generated from the service config.

Value parameters

apiShortName

Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".

codeownerGithubTeams

GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.

docTagPrefix

A prefix used in sample code when demarking regions to be included in documentation.

documentationUri

Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview

githubLabel

GitHub label to apply to issues and pull requests opened for this API.

librarySettings

Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.

methodSettings

A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.

newIssueUri

Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103

organization

For whom the client library is being published.

protoReferenceDocumentationUri

Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc

restReferenceDocumentationUri

Optional link to REST reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rest

Attributes

Companion
object
Source
Publishing.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Publishing extends GeneratedMessageCompanion[Publishing]

Attributes

Companion
class
Source
Publishing.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Publishing.type
final case class PythonSettings(common: Option[CommonLanguageSettings], experimentalFeatures: Option[ExperimentalFeatures], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[PythonSettings]

Settings for Python client libraries.

Settings for Python client libraries.

Value parameters

common

Some settings.

experimentalFeatures

Experimental features to be included during client library generation.

Attributes

Companion
object
Source
PythonSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PythonSettings extends GeneratedMessageCompanion[PythonSettings]

Attributes

Companion
class
Source
PythonSettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RubySettings(common: Option[CommonLanguageSettings], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RubySettings]

Settings for Ruby client libraries.

Settings for Ruby client libraries.

Value parameters

common

Some settings.

Attributes

Companion
object
Source
RubySettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RubySettings extends GeneratedMessageCompanion[RubySettings]

Attributes

Companion
class
Source
RubySettings.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class SelectiveGapicGeneration(methods: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[SelectiveGapicGeneration]

This message is used to configure the generation of a subset of the RPCs in a service for client libraries.

This message is used to configure the generation of a subset of the RPCs in a service for client libraries.

Value parameters

methods

An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.

Attributes

Companion
object
Source
SelectiveGapicGeneration.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SelectiveGapicGeneration extends GeneratedMessageCompanion[SelectiveGapicGeneration]

Attributes

Companion
class
Source
SelectiveGapicGeneration.scala
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Generated with