http4s-grpc-google-common-protos
2.18.0+0.0.5
API
Generated with
http4s-grpc-google-common-protos/com.google.api.client

com.google.api.client

package com.google.api.client

Members list

Concise view

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
Graph
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object GITHUB.type
object PACKAGE_MANAGER.type
object ClientLibraryDestination extends GeneratedEnumCompanion[ClientLibraryDestination]

Attributes

Companion:
class
Source:
ClientLibraryDestination.scala
Graph
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[ClientLibraryDestination]
trait Serializable
class Object
trait Matchable
class Any
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
Graph
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object ADS.type
object CLOUD.type
object GENERATIVE_AI.type
object GEO.type
object PHOTOS.type
object SHOPPING.type
object STREET_VIEW.type
object ClientLibraryOrganization extends GeneratedEnumCompanion[ClientLibraryOrganization]

Attributes

Companion:
class
Source:
ClientLibraryOrganization.scala
Graph
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[ClientLibraryOrganization]
trait Serializable
class Object
trait Matchable
class Any
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 with Updatable[ClientLibrarySettings]

Details about how and where to publish client libraries.

Details about how and where to publish client libraries.

Attributes

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".

Companion:
object
Source:
ClientLibrarySettings.scala
Graph
Supertypes
trait Updatable[ClientLibrarySettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ClientLibrarySettings extends GeneratedMessageCompanion[ClientLibrarySettings]

Attributes

Companion:
class
Source:
ClientLibrarySettings.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ClientLibrarySettings]
trait Serializable
class Object
trait Matchable
class Any
Self type
object ClientProto extends GeneratedFileObject

Attributes

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

Required information for every language.

Required information for every language.

Attributes

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

Companion:
object
Source:
CommonLanguageSettings.scala
Graph
Supertypes
trait Updatable[CommonLanguageSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CommonLanguageSettings extends GeneratedMessageCompanion[CommonLanguageSettings]

Attributes

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

Settings for C++ client libraries.

Settings for C++ client libraries.

Attributes

common

Some settings.

Companion:
object
Source:
CppSettings.scala
Graph
Supertypes
trait Updatable[CppSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CppSettings extends GeneratedMessageCompanion[CppSettings]

Attributes

Companion:
class
Source:
CppSettings.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CppSettings]
trait Serializable
class Object
trait Matchable
class Any
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 with Updatable[DotnetSettings]

Settings for Dotnet client libraries.

Settings for Dotnet client libraries.

Attributes

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.

Companion:
object
Source:
DotnetSettings.scala
Graph
Supertypes
trait Updatable[DotnetSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DotnetSettings extends GeneratedMessageCompanion[DotnetSettings]

Attributes

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

Settings for Go client libraries.

Settings for Go client libraries.

Attributes

common

Some settings.

Companion:
object
Source:
GoSettings.scala
Graph
Supertypes
trait Updatable[GoSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GoSettings extends GeneratedMessageCompanion[GoSettings]

Attributes

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

Settings for Java client libraries.

Settings for Java client libraries.

Attributes

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

Companion:
object
Source:
JavaSettings.scala
Graph
Supertypes
trait Updatable[JavaSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object JavaSettings extends GeneratedMessageCompanion[JavaSettings]

Attributes

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

Describes the generator configuration for a method.

Describes the generator configuration for a method.

Attributes

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: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 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.

Companion:
object
Source:
MethodSettings.scala
Graph
Supertypes
trait Updatable[MethodSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object MethodSettings extends GeneratedMessageCompanion[MethodSettings]

Attributes

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

Settings for Node client libraries.

Settings for Node client libraries.

Attributes

common

Some settings.

Companion:
object
Source:
NodeSettings.scala
Graph
Supertypes
trait Updatable[NodeSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object NodeSettings extends GeneratedMessageCompanion[NodeSettings]

Attributes

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

Settings for Php client libraries.

Settings for Php client libraries.

Attributes

common

Some settings.

Companion:
object
Source:
PhpSettings.scala
Graph
Supertypes
trait Updatable[PhpSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object PhpSettings extends GeneratedMessageCompanion[PhpSettings]

Attributes

Companion:
class
Source:
PhpSettings.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PhpSettings]
trait Serializable
class Object
trait Matchable
class Any
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, unknownFields: UnknownFieldSet) extends GeneratedMessage with 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.

Attributes

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

Companion:
object
Source:
Publishing.scala
Graph
Supertypes
trait Updatable[Publishing]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Publishing extends GeneratedMessageCompanion[Publishing]

Attributes

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

Settings for Python client libraries.

Settings for Python client libraries.

Attributes

common

Some settings.

Companion:
object
Source:
PythonSettings.scala
Graph
Supertypes
trait Updatable[PythonSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object PythonSettings extends GeneratedMessageCompanion[PythonSettings]

Attributes

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

Settings for Ruby client libraries.

Settings for Ruby client libraries.

Attributes

common

Some settings.

Companion:
object
Source:
RubySettings.scala
Graph
Supertypes
trait Updatable[RubySettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object RubySettings extends GeneratedMessageCompanion[RubySettings]

Attributes

Companion:
class
Source:
RubySettings.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RubySettings]
trait Serializable
class Object
trait Matchable
class Any
Self type
Generated with