Package com.google.api (2.38.0)

GitHub Repository

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.apps.card.v1 for new applications.

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.api.ClientLibrarySettings

Details about how and where to publish client libraries.

com.google.api.CommonLanguageSettings

Required information for every language.

com.google.api.CppSettings

Settings for C++ client libraries.

com.google.api.DotnetSettings

Settings for Dotnet client libraries.

com.google.api.GoSettings

Settings for Go client libraries.

com.google.api.JavaSettings

Settings for Java client libraries.

com.google.api.MethodSettings

Describes the generator configuration for a method.

com.google.api.NodeSettings

Settings for Node client libraries.

com.google.api.PhpSettings

Settings for Php client libraries.

com.google.api.PythonSettings

Settings for Python client libraries.

com.google.api.RubySettings

Settings for Ruby client libraries.

Classes

Class Description
com.google.api.Advice Generated advice about this change, used for providing more information about how a change will affect the existing service.
com.google.api.Advice.Builder Generated advice about this change, used for providing more information about how a change will affect the existing service.
com.google.api.AnnotationsProto
com.google.api.AuthProto
com.google.api.AuthProvider Configuration for an authentication provider, including support for JSON Web Token (JWT).
com.google.api.AuthProvider.Builder Configuration for an authentication provider, including support for JSON Web Token (JWT).
com.google.api.AuthRequirement User-defined authentication requirements, including support for JSON Web Token (JWT).
com.google.api.AuthRequirement.Builder User-defined authentication requirements, including support for JSON Web Token (JWT).
com.google.api.Authentication Authentication defines the authentication configuration for API methods provided by an API service.
com.google.api.Authentication.Builder Authentication defines the authentication configuration for API methods provided by an API service.
com.google.api.AuthenticationRule Authentication rules for the service. By default, if a method has any authentication requirements, every request
com.google.api.AuthenticationRule.Builder Authentication rules for the service. By default, if a method has any authentication requirements, every request
com.google.api.Backend Backend defines the backend configuration for a service.
com.google.api.Backend.Builder Backend defines the backend configuration for a service.
com.google.api.BackendProto
com.google.api.BackendRule A backend rule provides configuration for an individual API element.
com.google.api.BackendRule.Builder A backend rule provides configuration for an individual API element.
com.google.api.Billing Billing related configuration of the service. The following example shows how to configure monitored resources and metrics
com.google.api.Billing.BillingDestination Configuration of a specific billing destination (Currently only support bill against consumer project).
com.google.api.Billing.BillingDestination.Builder Configuration of a specific billing destination (Currently only support bill against consumer project).
com.google.api.Billing.Builder Billing related configuration of the service. The following example shows how to configure monitored resources and metrics
com.google.api.BillingProto
com.google.api.ClientLibrarySettings.Builder Details about how and where to publish client libraries.
com.google.api.ClientProto
com.google.api.CommonLanguageSettings.Builder Required information for every language.
com.google.api.ConfigChange Output generated from semantically comparing two versions of a service configuration.
com.google.api.ConfigChange.Builder Output generated from semantically comparing two versions of a service configuration.
com.google.api.ConfigChangeProto
com.google.api.ConsumerProto
com.google.api.Context Context defines which contexts an API requests. Example:
com.google.api.Context.Builder Context defines which contexts an API requests. Example:
com.google.api.ContextProto
com.google.api.ContextRule A context rule provides information about the context for an individual API element.
com.google.api.ContextRule.Builder A context rule provides information about the context for an individual API element.
com.google.api.Control Selects and configures the service controller used by the service. Example:
com.google.api.Control.Builder Selects and configures the service controller used by the service. Example:
com.google.api.ControlProto
com.google.api.CppSettings.Builder Settings for C++ client libraries.
com.google.api.CustomHttpPattern A custom pattern is used for defining custom HTTP verb.
com.google.api.CustomHttpPattern.Builder A custom pattern is used for defining custom HTTP verb.
com.google.api.Distribution Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.
com.google.api.Distribution.BucketOptions BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly.
com.google.api.Distribution.BucketOptions.Builder BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly.
com.google.api.Distribution.BucketOptions.Explicit Specifies a set of buckets with arbitrary widths. There are size(bounds) + 1 (= N) buckets. Bucket i has the following
com.google.api.Distribution.BucketOptions.Explicit.Builder Specifies a set of buckets with arbitrary widths. There are size(bounds) + 1 (= N) buckets. Bucket i has the following
com.google.api.Distribution.BucketOptions.Exponential Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.
com.google.api.Distribution.BucketOptions.Exponential.Builder Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.
com.google.api.Distribution.BucketOptions.Linear Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.
com.google.api.Distribution.BucketOptions.Linear.Builder Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.
com.google.api.Distribution.Builder Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.
com.google.api.Distribution.Exemplar Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that
com.google.api.Distribution.Exemplar.Builder Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that
com.google.api.Distribution.Range The range of the population values.
com.google.api.Distribution.Range.Builder The range of the population values.
com.google.api.DistributionProto
com.google.api.Documentation Documentation provides the information for describing a service. Example:
com.google.api.Documentation.Builder Documentation provides the information for describing a service. Example:
com.google.api.DocumentationProto
com.google.api.DocumentationRule A documentation rule provides information about individual API elements.
com.google.api.DocumentationRule.Builder A documentation rule provides information about individual API elements.
com.google.api.DotnetSettings.Builder Settings for Dotnet client libraries.
com.google.api.Endpoint Endpoint describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same
com.google.api.Endpoint.Builder Endpoint describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same
com.google.api.EndpointProto
com.google.api.ErrorReasonProto
com.google.api.FieldBehaviorProto
com.google.api.FieldInfo Rich semantic information of an API field beyond basic typing.
com.google.api.FieldInfo.Builder Rich semantic information of an API field beyond basic typing.
com.google.api.FieldInfoProto
com.google.api.FieldPolicy Google API Policy Annotation This message defines a simple API policy annotation that can be used to
com.google.api.FieldPolicy.Builder Google API Policy Annotation This message defines a simple API policy annotation that can be used to
com.google.api.GoSettings.Builder Settings for Go client libraries.
com.google.api.Http Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
com.google.api.Http.Builder Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
com.google.api.HttpBody Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
com.google.api.HttpBody.Builder Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
com.google.api.HttpBodyProto
com.google.api.HttpProto
com.google.api.HttpRule # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or
com.google.api.HttpRule.Builder # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or
com.google.api.JavaSettings.Builder Settings for Java client libraries.
com.google.api.JwtLocation Specifies a location to extract JWT from an API request.
com.google.api.JwtLocation.Builder Specifies a location to extract JWT from an API request.
com.google.api.LabelDescriptor A description of a label.
com.google.api.LabelDescriptor.Builder A description of a label.
com.google.api.LabelProto
com.google.api.LaunchStageProto
com.google.api.LogDescriptor A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history
com.google.api.LogDescriptor.Builder A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history
com.google.api.LogProto
com.google.api.Logging Logging configuration of the service. The following example shows how to configure logs to be sent to the
com.google.api.Logging.Builder Logging configuration of the service. The following example shows how to configure logs to be sent to the
com.google.api.Logging.LoggingDestination Configuration of a specific logging destination (the producer project or the consumer project).
com.google.api.Logging.LoggingDestination.Builder Configuration of a specific logging destination (the producer project or the consumer project).
com.google.api.LoggingProto
com.google.api.MethodPolicy Defines policies applying to an RPC method.
com.google.api.MethodPolicy.Builder Defines policies applying to an RPC method.
com.google.api.MethodSettings.Builder Describes the generator configuration for a method.
com.google.api.MethodSettings.LongRunning Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library
com.google.api.MethodSettings.LongRunning.Builder Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library
com.google.api.Metric A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.
com.google.api.Metric.Builder A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.
com.google.api.MetricDescriptor Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
com.google.api.MetricDescriptor.Builder Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
com.google.api.MetricDescriptor.MetricDescriptorMetadata Additional annotations that can be used to guide the usage of a metric.
com.google.api.MetricDescriptor.MetricDescriptorMetadata.Builder Additional annotations that can be used to guide the usage of a metric.
com.google.api.MetricProto
com.google.api.MetricRule Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.
com.google.api.MetricRule.Builder Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.
com.google.api.MonitoredResource An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a
com.google.api.MonitoredResource.Builder An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a
com.google.api.MonitoredResourceDescriptor An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for
com.google.api.MonitoredResourceDescriptor.Builder An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for
com.google.api.MonitoredResourceMetadata Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource
com.google.api.MonitoredResourceMetadata.Builder Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource
com.google.api.MonitoredResourceProto
com.google.api.Monitoring Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics
com.google.api.Monitoring.Builder Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics
com.google.api.Monitoring.MonitoringDestination Configuration of a specific monitoring destination (the producer project or the consumer project).
com.google.api.Monitoring.MonitoringDestination.Builder Configuration of a specific monitoring destination (the producer project or the consumer project).
com.google.api.MonitoringProto
com.google.api.NodeSettings.Builder Settings for Node client libraries.
com.google.api.OAuthRequirements OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application,
com.google.api.OAuthRequirements.Builder OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application,
com.google.api.Page Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
com.google.api.Page.Builder Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
com.google.api.PhpSettings.Builder Settings for Php client libraries.
com.google.api.PolicyProto
com.google.api.ProjectProperties A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be
com.google.api.ProjectProperties.Builder A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be
com.google.api.Property Defines project properties. API services can define properties that can be assigned to consumer projects
com.google.api.Property.Builder Defines project properties. API services can define properties that can be assigned to consumer projects
com.google.api.Publishing This message configures the settings for publishing Google Cloud Client libraries generated from the service config.
com.google.api.Publishing.Builder This message configures the settings for publishing Google Cloud Client libraries generated from the service config.
com.google.api.PythonSettings.Builder Settings for Python client libraries.
com.google.api.Quota Quota configuration helps to achieve fairness and budgeting in service usage.
com.google.api.Quota.Builder Quota configuration helps to achieve fairness and budgeting in service usage.
com.google.api.QuotaLimit QuotaLimit defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a QuotaGroup.
com.google.api.QuotaLimit.Builder QuotaLimit defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a QuotaGroup.
com.google.api.QuotaProto
com.google.api.ResourceDescriptor A simple descriptor of a resource type. ResourceDescriptor annotates a resource message (either by means of a
com.google.api.ResourceDescriptor.Builder A simple descriptor of a resource type. ResourceDescriptor annotates a resource message (either by means of a
com.google.api.ResourceProto
com.google.api.ResourceReference Defines a proto annotation that describes a string field that refers to an API resource.
com.google.api.ResourceReference.Builder Defines a proto annotation that describes a string field that refers to an API resource.
com.google.api.RoutingParameter A projection from an input message to the GRPC or REST header.
com.google.api.RoutingParameter.Builder A projection from an input message to the GRPC or REST header.
com.google.api.RoutingProto
com.google.api.RoutingRule Specifies the routing information that should be sent along with the request in the form of routing header. NOTE: All service configuration rules follow the "last one wins" order.
com.google.api.RoutingRule.Builder Specifies the routing information that should be sent along with the request in the form of routing header. NOTE: All service configuration rules follow the "last one wins" order.
com.google.api.RubySettings.Builder Settings for Ruby client libraries.
com.google.api.Service Service is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other
com.google.api.Service.Builder Service is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other
com.google.api.ServiceProto
com.google.api.SourceInfo Source information used to create a Service Config
com.google.api.SourceInfo.Builder Source information used to create a Service Config
com.google.api.SourceInfoProto
com.google.api.SystemParameter Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.
com.google.api.SystemParameter.Builder Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.
com.google.api.SystemParameterProto
com.google.api.SystemParameterRule Define a system parameter rule mapping system parameter definitions to methods.
com.google.api.SystemParameterRule.Builder Define a system parameter rule mapping system parameter definitions to methods.
com.google.api.SystemParameters ### System parameter configuration A system parameter is a special kind of parameter defined by the API
com.google.api.SystemParameters.Builder ### System parameter configuration A system parameter is a special kind of parameter defined by the API
com.google.api.Usage Configuration controlling usage of a service.
com.google.api.Usage.Builder Configuration controlling usage of a service.
com.google.api.UsageProto
com.google.api.UsageRule Usage configuration rules for the service. NOTE: Under development.
com.google.api.UsageRule.Builder Usage configuration rules for the service. NOTE: Under development.
com.google.api.Visibility Visibility restricts service consumer's access to service elements, such as whether an application can call a visibility-restricted method. The restriction is expressed by applying visibility labels on service
com.google.api.Visibility.Builder Visibility restricts service consumer's access to service elements, such as whether an application can call a visibility-restricted method. The restriction is expressed by applying visibility labels on service
com.google.api.VisibilityProto
com.google.api.VisibilityRule A visibility rule provides visibility configuration for an individual API element.
com.google.api.VisibilityRule.Builder A visibility rule provides visibility configuration for an individual API element.

Interfaces

Interface Description
com.google.api.AdviceOrBuilder
com.google.api.AuthProviderOrBuilder
com.google.api.AuthRequirementOrBuilder
com.google.api.AuthenticationOrBuilder
com.google.api.AuthenticationRuleOrBuilder
com.google.api.BackendOrBuilder
com.google.api.BackendRuleOrBuilder
com.google.api.Billing.BillingDestinationOrBuilder
com.google.api.BillingOrBuilder
com.google.api.ClientLibrarySettingsOrBuilder
com.google.api.CommonLanguageSettingsOrBuilder
com.google.api.ConfigChangeOrBuilder
com.google.api.ContextOrBuilder
com.google.api.ContextRuleOrBuilder
com.google.api.ControlOrBuilder
com.google.api.CppSettingsOrBuilder
com.google.api.CustomHttpPatternOrBuilder
com.google.api.Distribution.BucketOptions.ExplicitOrBuilder
com.google.api.Distribution.BucketOptions.ExponentialOrBuilder
com.google.api.Distribution.BucketOptions.LinearOrBuilder
com.google.api.Distribution.BucketOptionsOrBuilder
com.google.api.Distribution.ExemplarOrBuilder
com.google.api.Distribution.RangeOrBuilder
com.google.api.DistributionOrBuilder
com.google.api.DocumentationOrBuilder
com.google.api.DocumentationRuleOrBuilder
com.google.api.DotnetSettingsOrBuilder
com.google.api.EndpointOrBuilder
com.google.api.FieldInfoOrBuilder
com.google.api.FieldPolicyOrBuilder
com.google.api.GoSettingsOrBuilder
com.google.api.HttpBodyOrBuilder
com.google.api.HttpOrBuilder
com.google.api.HttpRuleOrBuilder
com.google.api.JavaSettingsOrBuilder
com.google.api.JwtLocationOrBuilder
com.google.api.LabelDescriptorOrBuilder
com.google.api.LogDescriptorOrBuilder
com.google.api.Logging.LoggingDestinationOrBuilder
com.google.api.LoggingOrBuilder
com.google.api.MethodPolicyOrBuilder
com.google.api.MethodSettings.LongRunningOrBuilder
com.google.api.MethodSettingsOrBuilder
com.google.api.MetricDescriptor.MetricDescriptorMetadataOrBuilder
com.google.api.MetricDescriptorOrBuilder
com.google.api.MetricOrBuilder
com.google.api.MetricRuleOrBuilder
com.google.api.MonitoredResourceDescriptorOrBuilder
com.google.api.MonitoredResourceMetadataOrBuilder
com.google.api.MonitoredResourceOrBuilder
com.google.api.Monitoring.MonitoringDestinationOrBuilder
com.google.api.MonitoringOrBuilder
com.google.api.NodeSettingsOrBuilder
com.google.api.OAuthRequirementsOrBuilder
com.google.api.PageOrBuilder
com.google.api.PhpSettingsOrBuilder
com.google.api.ProjectPropertiesOrBuilder
com.google.api.PropertyOrBuilder
com.google.api.PublishingOrBuilder
com.google.api.PythonSettingsOrBuilder
com.google.api.QuotaLimitOrBuilder
com.google.api.QuotaOrBuilder
com.google.api.ResourceDescriptorOrBuilder
com.google.api.ResourceReferenceOrBuilder
com.google.api.RoutingParameterOrBuilder
com.google.api.RoutingRuleOrBuilder
com.google.api.RubySettingsOrBuilder
com.google.api.ServiceOrBuilder
com.google.api.SourceInfoOrBuilder
com.google.api.SystemParameterOrBuilder
com.google.api.SystemParameterRuleOrBuilder
com.google.api.SystemParametersOrBuilder
com.google.api.UsageOrBuilder
com.google.api.UsageRuleOrBuilder
com.google.api.VisibilityOrBuilder
com.google.api.VisibilityRuleOrBuilder

Enums

Enum Description
com.google.api.BackendRule.AuthenticationCase
com.google.api.BackendRule.PathTranslation Path Translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request.
com.google.api.ChangeType Classifies set of possible modifications to an object in the service configuration.
com.google.api.ClientLibraryDestination To where should client libraries be published?
com.google.api.ClientLibraryOrganization The organization for which the client libraries are being published. Affects the url where generated docs are published, etc.
com.google.api.Distribution.BucketOptions.OptionsCase
com.google.api.ErrorReason Defines the supported values for google.rpc.ErrorInfo.reason for the googleapis.com error domain. This error domain is reserved for Service Infrastructure.
com.google.api.FieldBehavior An indicator of the behavior of a given field (for example, that a field is required in requests, or given as output but ignored as input). This does not change the behavior in protocol buffers itself; it only
com.google.api.FieldInfo.Format The standard format of a field value. The supported formats are all backed by either an RFC defined by the IETF or a Google-defined AIP.
com.google.api.HttpRule.PatternCase
com.google.api.JwtLocation.InCase
com.google.api.LabelDescriptor.ValueType Value types that can be used as label values.
com.google.api.LaunchStage The launch stage as defined by Google Cloud Platform Launch Stages.
com.google.api.MetricDescriptor.MetricKind The kind of measurement. It describes how the data is reported. For information on setting the start time and end time based on the MetricKind, see TimeInterval.
com.google.api.MetricDescriptor.ValueType The value type of a metric.
com.google.api.Property.PropertyType Supported data type of the property values
com.google.api.ResourceDescriptor.History A description of the historical or future-looking state of the resource pattern.
com.google.api.ResourceDescriptor.Style A flag representing a specific style that a resource claims to conform to.