Movatterモバイル変換


[0]ホーム

URL:


serviceusage

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:34

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package serviceusage provides access to the Service Usage API.

For product documentation, see:https://cloud.google.com/service-usage/

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/serviceusage/v1beta1"...ctx := context.Background()serviceusageService, err := serviceusage.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

serviceusageService, err := serviceusage.NewService(ctx, option.WithScopes(serviceusage.ServiceManagementScope))

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

serviceusageService, err := serviceusage.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)serviceusageService, err := serviceusage.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"// View your data across Google Cloud services and see the email address of// your Google AccountCloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"// Manage your Google API service configurationServiceManagementScope = "https://www.googleapis.com/auth/service.management")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAPIService

type APIService struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentOperations *OperationsServiceServices *ServicesService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*APIService,error)

New creates a new APIService. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*APIService,error)

NewService creates a new APIService.

typeAddEnableRulesMetadataadded inv0.123.0

type AddEnableRulesMetadata struct {}

AddEnableRulesMetadata: Metadata for the `AddEnableRules` method.

typeAddEnableRulesResponseadded inv0.123.0

type AddEnableRulesResponse struct {// AddedValues: The values added to the parent consumer policy.AddedValues []string `json:"addedValues,omitempty"`// Parent: The parent consumer policy. It can be// `projects/12345/consumerPolicies/default`, or// `folders/12345/consumerPolicies/default`, or// `organizations/12345/consumerPolicies/default`.Parentstring `json:"parent,omitempty"`// ForceSendFields is a list of field names (e.g. "AddedValues") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AddedValues") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AddEnableRulesResponse: The response message of `AddEnableRules` method.

func (AddEnableRulesResponse)MarshalJSONadded inv0.123.0

func (sAddEnableRulesResponse) MarshalJSON() ([]byte,error)

typeAdminQuotaPolicyadded inv0.27.0

type AdminQuotaPolicy struct {// Container: The cloud resource container at which the quota policy is// created. The format is `{container_type}/{container_number}`Containerstring `json:"container,omitempty"`// Dimensions:  If this map is nonempty, then this policy applies only to// specific values for dimensions defined in the limit unit. For example, a// policy on a limit with the unit `1/{project}/{region}` could contain an// entry with the key `region` and the value `us-east-1`; the policy is only// applied to quota consumed in that region. This map has the following// restrictions: * If `region` appears as a key, its value must be a valid// Cloud region. * If `zone` appears as a key, its value must be a valid Cloud// zone. * Keys other than `region` or `zone` are not valid.Dimensions map[string]string `json:"dimensions,omitempty"`// Metric: The name of the metric to which this policy applies. An example name// would be: `compute.googleapis.com/cpus`Metricstring `json:"metric,omitempty"`// Name: The resource name of the policy. This name is generated by the server// when the policy is created. Example names would be:// `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compu// te.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c// 1d`Namestring `json:"name,omitempty"`// PolicyValue: The quota policy value. Can be any nonnegative integer, or -1// (unlimited quota).PolicyValueint64 `json:"policyValue,omitempty,string"`// Unit: The limit unit of the limit to which this policy applies. An example// unit would be: `1/{project}/{region}` Note that `{project}` and `{region}`// are not placeholders in this example; the literal characters `{` and `}`// occur in the string.Unitstring `json:"unit,omitempty"`// ForceSendFields is a list of field names (e.g. "Container") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Container") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AdminQuotaPolicy: Quota policy created by quota administrator.

func (AdminQuotaPolicy)MarshalJSONadded inv0.27.0

func (sAdminQuotaPolicy) MarshalJSON() ([]byte,error)

typeAnalysisadded inv0.193.0

type Analysis struct {// Analysis: Output only. Analysis result of updating a policy.Analysis *AnalysisResult `json:"analysis,omitempty"`// AnalysisType: Output only. The type of analysis.//// Possible values://   "ANALYSIS_TYPE_UNSPECIFIED" - Unspecified analysis type. Do not use.//   "ANALYSIS_TYPE_DEPENDENCY" - The analysis of service dependencies.//   "ANALYSIS_TYPE_RESOURCE_USAGE" - The analysis of service resource usage.//   "ANALYSIS_TYPE_RESOURCE_EXISTENCE" - The analysis of service resource// existence.AnalysisTypestring `json:"analysisType,omitempty"`// DisplayName: Output only. The user friendly display name of the analysis// type. E.g. service dependency analysis, service resource usage analysis,// etc.DisplayNamestring `json:"displayName,omitempty"`// Service: The names of the service that has analysis result of warnings or// blockers. Example: `services/storage.googleapis.com`.Servicestring `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "Analysis") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Analysis") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Analysis: A message to group the analysis information.

func (Analysis)MarshalJSONadded inv0.193.0

func (sAnalysis) MarshalJSON() ([]byte,error)

typeAnalysisResultadded inv0.193.0

type AnalysisResult struct {// Blockers: Blocking information that would prevent the policy changes at// runtime.Blockers []*Impact `json:"blockers,omitempty"`// Warnings: Warning information indicating that the policy changes might be// unsafe, but will not block the changes at runtime.Warnings []*Impact `json:"warnings,omitempty"`// ForceSendFields is a list of field names (e.g. "Blockers") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Blockers") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AnalysisResult: An analysis result including blockers and warnings.

func (AnalysisResult)MarshalJSONadded inv0.193.0

func (sAnalysisResult) MarshalJSON() ([]byte,error)

typeAnalyzeConsumerPolicyMetadataadded inv0.193.0

type AnalyzeConsumerPolicyMetadata struct {}

AnalyzeConsumerPolicyMetadata: Metadata for the `AnalyzeConsumerPolicy`method.

typeAnalyzeConsumerPolicyResponseadded inv0.193.0

type AnalyzeConsumerPolicyResponse struct {// Analysis: The list of analyses returned from performing the intended policy// update analysis. The analysis is grouped by service name and different// analysis types. The empty analysis list means that the consumer policy can// be updated without any warnings or blockers.Analysis []*Analysis `json:"analysis,omitempty"`// ForceSendFields is a list of field names (e.g. "Analysis") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Analysis") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AnalyzeConsumerPolicyResponse: The response of analyzing a consumer policyupdate.

func (AnalyzeConsumerPolicyResponse)MarshalJSONadded inv0.193.0

func (sAnalyzeConsumerPolicyResponse) MarshalJSON() ([]byte,error)

typeApi

type Api struct {// Edition: The source edition string, only valid when syntax is// SYNTAX_EDITIONS.Editionstring `json:"edition,omitempty"`// Methods: The methods of this interface, in unspecified order.Methods []*Method `json:"methods,omitempty"`// Mixins: Included interfaces. See Mixin.Mixins []*Mixin `json:"mixins,omitempty"`// Name: The fully qualified name of this interface, including package name// followed by the interface's simple name.Namestring `json:"name,omitempty"`// Options: Any metadata attached to the interface.Options []*Option `json:"options,omitempty"`// SourceContext: Source context for the protocol buffer service represented by// this message.SourceContext *SourceContext `json:"sourceContext,omitempty"`// Syntax: The source syntax of the service.//// Possible values://   "SYNTAX_PROTO2" - Syntax `proto2`.//   "SYNTAX_PROTO3" - Syntax `proto3`.//   "SYNTAX_EDITIONS" - Syntax `editions`.Syntaxstring `json:"syntax,omitempty"`// Version: A version string for this interface. If specified, must have the// form `major-version.minor-version`, as in `1.10`. If the minor version is// omitted, it defaults to zero. If the entire version field is empty, the// major version is derived from the package name, as outlined below. If the// field is not empty, the version in the package name will be verified to be// consistent with what is provided here. The versioning schema uses semantic// versioning (http://semver.org) where the major version number indicates a// breaking change and the minor version an additive, non-breaking change. Both// version numbers are signals to users what to expect from different versions,// and should be carefully chosen based on the product plan. The major version// is also reflected in the package name of the interface, which must end in// `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can// be omitted. Zero major versions must only be used for experimental, non-GA// interfaces.Versionstring `json:"version,omitempty"`// ForceSendFields is a list of field names (e.g. "Edition") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Edition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Api: Api is a light-weight descriptor for an API Interface. Interfaces arealso described as "protocol buffer services" in some contexts, such as bythe "service" keyword in a .proto file, but they are different from APIServices, which represent a concrete implementation of an interface asopposed to simply a description of methods and bindings. They are alsosometimes simply referred to as "APIs" in other contexts, such as the nameof this message itself. Seehttps://cloud.google.com/apis/design/glossaryfor detailed terminology. New usages of this message as an alternative toServiceDescriptorProto are strongly discouraged. This message does notreliability preserve all information necessary to model the schema andpreserve semantics. Instead make use of FileDescriptorSet which preservesthe necessary information.

func (Api)MarshalJSON

func (sApi) MarshalJSON() ([]byte,error)

typeAspectadded inv0.223.0

type Aspect struct {// Kind: The type of this aspect configuration.Kindstring `json:"kind,omitempty"`// Spec: Content of the configuration. The underlying schema should be defined// by Aspect owners as protobuf message under `google/api/configaspects/proto`.Specgoogleapi.RawMessage `json:"spec,omitempty"`// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Kind") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Aspect: Aspect represents Generic aspect. It is used to configure an aspectwithout making direct changes to service.proto

func (Aspect)MarshalJSONadded inv0.223.0

func (sAspect) MarshalJSON() ([]byte,error)

typeAuthProvider

type AuthProvider struct {// Audiences: The list of JWT audiences// (https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).// that are allowed to access. A JWT containing any of these audiences will be// accepted. When this setting is absent, JWTs with audiences: -// "https://[service.name]/[google.protobuf.Api.name]" -// "https://[service.name]/" will be accepted. For example, if no audiences are// in the setting, LibraryService API will accept JWTs with the following// audiences: -//https://library-example.googleapis.com/google.example.library.v1.LibraryService// -https://library-example.googleapis.com/ Example: audiences:// bookstore_android.apps.googleusercontent.com,// bookstore_web.apps.googleusercontent.comAudiencesstring `json:"audiences,omitempty"`// AuthorizationUrl: Redirect URL if JWT token is required but not present or// is expired. Implement authorizationUrl of securityDefinitions in OpenAPI// spec.AuthorizationUrlstring `json:"authorizationUrl,omitempty"`// Id: The unique identifier of the auth provider. It will be referred to by// `AuthRequirement.provider_id`. Example: "bookstore_auth".Idstring `json:"id,omitempty"`// Issuer: Identifies the principal that issued the JWT. See//https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1// Usually a URL or an email address. Example:https://securetoken.google.com// Example: 1234567-compute@developer.gserviceaccount.comIssuerstring `json:"issuer,omitempty"`// JwksUri: URL of the provider's public key set to validate signature of the// JWT. See OpenID Discovery// (https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).// Optional if the key set document: - can be retrieved from OpenID Discovery// (https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer.// - can be inferred from the email domain of the issuer (e.g. a Google service// account). Example:https://www.googleapis.com/oauth2/v1/certsJwksUristring `json:"jwksUri,omitempty"`// JwtLocations: Defines the locations to extract the JWT. For now it is only// used by the Cloud Endpoints to store the OpenAPI extension// [x-google-jwt-locations]// (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations)// JWT locations can be one of HTTP headers, URL query parameters or cookies.// The rule is that the first match wins. If not specified, default to use// following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion// 3) access_token query parameter Default locations can be specified as// followings: jwt_locations: - header: Authorization value_prefix: "Bearer " -// header: x-goog-iap-jwt-assertion - query: access_tokenJwtLocations []*JwtLocation `json:"jwtLocations,omitempty"`// ForceSendFields is a list of field names (e.g. "Audiences") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Audiences") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AuthProvider: Configuration for an authentication provider, includingsupport for JSON Web Token (JWT)(https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (AuthProvider)MarshalJSON

func (sAuthProvider) MarshalJSON() ([]byte,error)

typeAuthRequirement

type AuthRequirement struct {// Audiences: NOTE: This will be deprecated soon, once AuthProvider.audiences// is implemented and accepted in all the runtime components. The list of JWT// audiences// (https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).// that are allowed to access. A JWT containing any of these audiences will be// accepted. When this setting is absent, only JWTs with audience// "https://Service_name/API_name" will be accepted. For example, if no// audiences are in the setting, LibraryService API will only accept JWTs with// the following audience// "https://library-example.googleapis.com/google.example.library.v1.LibraryServ// ice". Example: audiences: bookstore_android.apps.googleusercontent.com,// bookstore_web.apps.googleusercontent.comAudiencesstring `json:"audiences,omitempty"`// ProviderId: id from authentication provider. Example: provider_id:// bookstore_authProviderIdstring `json:"providerId,omitempty"`// ForceSendFields is a list of field names (e.g. "Audiences") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Audiences") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AuthRequirement: User-defined authentication requirements, including supportfor JSON Web Token (JWT)(https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

func (AuthRequirement)MarshalJSON

func (sAuthRequirement) MarshalJSON() ([]byte,error)

typeAuthentication

type Authentication struct {// Providers: Defines a set of authentication providers that a service// supports.Providers []*AuthProvider `json:"providers,omitempty"`// Rules: A list of authentication rules that apply to individual API methods.// **NOTE:** All service configuration rules follow "last one wins" order.Rules []*AuthenticationRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g. "Providers") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Providers") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Authentication: `Authentication` defines the authentication configurationfor API methods provided by an API service. Example: name:calendar.googleapis.com authentication: providers: - id:google_calendar_auth jwks_uri:https://www.googleapis.com/oauth2/v1/certsissuer:https://securetoken.google.com rules: - selector: "*" requirements:provider_id: google_calendar_auth - selector: google.calendar.Delegateoauth: canonical_scopes:https://www.googleapis.com/auth/calendar.read

func (Authentication)MarshalJSON

func (sAuthentication) MarshalJSON() ([]byte,error)

typeAuthenticationRule

type AuthenticationRule struct {// AllowWithoutCredential: If true, the service accepts API keys without any// other credential. This flag only applies to HTTP and gRPC requests.AllowWithoutCredentialbool `json:"allowWithoutCredential,omitempty"`// Oauth: The requirements for OAuth credentials.Oauth *OAuthRequirements `json:"oauth,omitempty"`// Requirements: Requirements for additional authentication providers.Requirements []*AuthRequirement `json:"requirements,omitempty"`// Selector: Selects the methods to which this rule applies. Refer to selector// for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowWithoutCredential") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowWithoutCredential") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AuthenticationRule: Authentication rules for the service. By default, if amethod has any authentication requirements, every request must include avalid credential matching one of the requirements. It's an error to includemore than one kind of credential in a single request. If a method doesn'thave any auth requirements, request credentials will be ignored.

func (AuthenticationRule)MarshalJSON

func (sAuthenticationRule) MarshalJSON() ([]byte,error)

typeBackend

type Backend struct {// Rules: A list of API backend rules that apply to individual API methods.// **NOTE:** All service configuration rules follow "last one wins" order.Rules []*BackendRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g. "Rules") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Rules") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Backend: `Backend` defines the backend configuration for a service.

func (Backend)MarshalJSON

func (sBackend) MarshalJSON() ([]byte,error)

typeBackendRule

type BackendRule struct {// Address: The address of the API backend. The scheme is used to determine the// backend protocol and security. The following schemes are accepted: SCHEME// PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None// grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving// out the scheme may cause constrasting behaviors across platforms. If the// port is unspecified, the default is: - 80 for schemes without TLS - 443 for// schemes with TLS For HTTP backends, use protocol to specify the protocol// version.Addressstring `json:"address,omitempty"`// Deadline: The number of seconds to wait for a response from a request. The// default varies based on the request protocol and deployment environment.Deadlinefloat64 `json:"deadline,omitempty"`// DisableAuth: When disable_auth is true, a JWT ID token won't be generated// and the original "Authorization" HTTP header will be preserved. If the// header is used to carry the original token and is expected by the backend,// this field must be set to true to preserve the header.DisableAuthbool `json:"disableAuth,omitempty"`// JwtAudience: The JWT audience is used when generating a JWT ID token for the// backend. This ID token will be added in the HTTP "authorization" header, and// sent to the backend.JwtAudiencestring `json:"jwtAudience,omitempty"`// LoadBalancingPolicy: The load balancing policy used for connection to the// application backend. Defined as an arbitrary string to accomondate custom// load balancing policies supported by the underlying channel, but suggest// most users use one of the standard policies, such as the default,// "RoundRobin".LoadBalancingPolicystring `json:"loadBalancingPolicy,omitempty"`// MinDeadline: Deprecated, do not use.MinDeadlinefloat64 `json:"minDeadline,omitempty"`// OperationDeadline: The number of seconds to wait for the completion of a// long running operation. The default is no deadline.OperationDeadlinefloat64 `json:"operationDeadline,omitempty"`// OverridesByRequestProtocol: The map between request protocol and the backend// address.OverridesByRequestProtocol map[string]BackendRule `json:"overridesByRequestProtocol,omitempty"`// PathTranslation: no-lint//// Possible values://   "PATH_TRANSLATION_UNSPECIFIED"//   "CONSTANT_ADDRESS" - Use the backend address as-is, with no modification// to the path. If the URL pattern contains variables, the variable names and// values will be appended to the query string. If a query string parameter and// a URL pattern variable have the same name, this may result in duplicate keys// in the query string. # Examples Given the following operation config: Method// path: /api/company/{cid}/user/{uid} Backend address://https://example.cloudfunctions.net/getUser Requests to the following request// paths will call the backend at the translated path: Request path:// /api/company/widgetworks/user/johndoe Translated://https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe// Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated://https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe//   "APPEND_PATH_TO_ADDRESS" - The request path will be appended to the// backend address. # Examples Given the following operation config: Method// path: /api/company/{cid}/user/{uid} Backend address://https://example.appspot.com Requests to the following request paths will// call the backend at the translated path: Request path:// /api/company/widgetworks/user/johndoe Translated://https://example.appspot.com/api/company/widgetworks/user/johndoe Request// path: /api/company/widgetworks/user/johndoe?timezone=EST Translated://https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=ESTPathTranslationstring `json:"pathTranslation,omitempty"`// Protocol: The protocol used for sending a request to the backend. The// supported values are "http/1.1" and "h2". The default value is inferred from// the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https://// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that// support HTTP/2, set this field to "h2" for improved performance. Configuring// this field to non-default values is only supported for secure HTTP backends.// This field will be ignored for all other backends. See//https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids// for more details on the supported values.Protocolstring `json:"protocol,omitempty"`// Selector: Selects the methods to which this rule applies. Refer to selector// for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "Address") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Address") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BackendRule: A backend rule provides configuration for an individual APIelement.

func (BackendRule)MarshalJSON

func (sBackendRule) MarshalJSON() ([]byte,error)

func (*BackendRule)UnmarshalJSON

func (s *BackendRule) UnmarshalJSON(data []byte)error

typeBatchCreateAdminOverridesResponseadded inv0.4.0

type BatchCreateAdminOverridesResponse struct {// Overrides: The overrides that were created.Overrides []*QuotaOverride `json:"overrides,omitempty"`// ForceSendFields is a list of field names (e.g. "Overrides") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Overrides") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchCreateAdminOverridesResponse: Response message forBatchCreateAdminOverrides

func (BatchCreateAdminOverridesResponse)MarshalJSONadded inv0.4.0

func (sBatchCreateAdminOverridesResponse) MarshalJSON() ([]byte,error)

typeBatchCreateConsumerOverridesResponseadded inv0.4.0

type BatchCreateConsumerOverridesResponse struct {// Overrides: The overrides that were created.Overrides []*QuotaOverride `json:"overrides,omitempty"`// ForceSendFields is a list of field names (e.g. "Overrides") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Overrides") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchCreateConsumerOverridesResponse: Response message forBatchCreateConsumerOverrides

func (BatchCreateConsumerOverridesResponse)MarshalJSONadded inv0.4.0

typeBatchEnableServicesRequest

type BatchEnableServicesRequest struct {// ServiceIds: The identifiers of the services to enable on the project. A// valid identifier would be: serviceusage.googleapis.com Enabling services// requires that each service is public or is shared with the user enabling the// service. Two or more services must be specified. To enable a single service,// use the `EnableService` method instead. A single request can enable a// maximum of 20 services at a time. If more than 20 services are specified,// the request will fail, and no state changes will occur.ServiceIds []string `json:"serviceIds,omitempty"`// ForceSendFields is a list of field names (e.g. "ServiceIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ServiceIds") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchEnableServicesRequest: Request message for the `BatchEnableServices`method.

func (BatchEnableServicesRequest)MarshalJSON

func (sBatchEnableServicesRequest) MarshalJSON() ([]byte,error)

typeBatchEnableServicesResponse

type BatchEnableServicesResponse struct {// Failures: If allow_partial_success is true, and one or more services could// not be enabled, this field contains the details about each failure.Failures []*EnableFailure `json:"failures,omitempty"`// Services: The new state of the services after enabling.Services []*GoogleApiServiceusageV1Service `json:"services,omitempty"`// ForceSendFields is a list of field names (e.g. "Failures") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Failures") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchEnableServicesResponse: Response message for the `BatchEnableServices`method. This response message is assigned to the `response` field of thereturned Operation when that operation is done.

func (BatchEnableServicesResponse)MarshalJSON

func (sBatchEnableServicesResponse) MarshalJSON() ([]byte,error)

typeBatchingConfigProtoadded inv0.235.0

type BatchingConfigProto struct {// BatchDescriptor: The request and response fields used in batching.BatchDescriptor *BatchingDescriptorProto `json:"batchDescriptor,omitempty"`// Thresholds: The thresholds which trigger a batched request to be sent.Thresholds *BatchingSettingsProto `json:"thresholds,omitempty"`// ForceSendFields is a list of field names (e.g. "BatchDescriptor") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BatchDescriptor") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchingConfigProto: `BatchingConfigProto` defines the batchingconfiguration for an API method.

func (BatchingConfigProto)MarshalJSONadded inv0.235.0

func (sBatchingConfigProto) MarshalJSON() ([]byte,error)

typeBatchingDescriptorProtoadded inv0.235.0

type BatchingDescriptorProto struct {// BatchedField: The repeated field in the request message to be aggregated by// batching.BatchedFieldstring `json:"batchedField,omitempty"`// DiscriminatorFields: A list of the fields in the request message. Two// requests will be batched together only if the values of every field// specified in `request_discriminator_fields` is equal between the two// requests.DiscriminatorFields []string `json:"discriminatorFields,omitempty"`// SubresponseField: Optional. When present, indicates the field in the// response message to be used to demultiplex the response into multiple// response messages, in correspondence with the multiple request messages// originally batched together.SubresponseFieldstring `json:"subresponseField,omitempty"`// ForceSendFields is a list of field names (e.g. "BatchedField") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BatchedField") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchingDescriptorProto: `BatchingDescriptorProto` specifies the fields ofthe request message to be used for batching, and, optionally, the fields ofthe response message to be used for demultiplexing.

func (BatchingDescriptorProto)MarshalJSONadded inv0.235.0

func (sBatchingDescriptorProto) MarshalJSON() ([]byte,error)

typeBatchingSettingsProtoadded inv0.235.0

type BatchingSettingsProto struct {// DelayThreshold: The duration after which a batch should be sent, starting// from the addition of the first message to that batch.DelayThresholdstring `json:"delayThreshold,omitempty"`// ElementCountLimit: The maximum number of elements collected in a batch that// could be accepted by server.ElementCountLimitint64 `json:"elementCountLimit,omitempty"`// ElementCountThreshold: The number of elements of a field collected into a// batch which, if exceeded, causes the batch to be sent.ElementCountThresholdint64 `json:"elementCountThreshold,omitempty"`// FlowControlByteLimit: The maximum size of data allowed by flow control.FlowControlByteLimitint64 `json:"flowControlByteLimit,omitempty"`// FlowControlElementLimit: The maximum number of elements allowed by flow// control.FlowControlElementLimitint64 `json:"flowControlElementLimit,omitempty"`// FlowControlLimitExceededBehavior: The behavior to take when the flow control// limit is exceeded.//// Possible values://   "UNSET_BEHAVIOR" - Default behavior, system-defined.//   "THROW_EXCEPTION" - Stop operation, raise error.//   "BLOCK" - Pause operation until limit clears.//   "IGNORE" - Continue operation, disregard limit.FlowControlLimitExceededBehaviorstring `json:"flowControlLimitExceededBehavior,omitempty"`// RequestByteLimit: The maximum size of the request that could be accepted by// server.RequestByteLimitint64 `json:"requestByteLimit,omitempty"`// RequestByteThreshold: The aggregated size of the batched field which, if// exceeded, causes the batch to be sent. This size is computed by aggregating// the sizes of the request field to be batched, not of the entire request// message.RequestByteThresholdint64 `json:"requestByteThreshold,omitempty,string"`// ForceSendFields is a list of field names (e.g. "DelayThreshold") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DelayThreshold") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchingSettingsProto: `BatchingSettingsProto` specifies a set of batchingthresholds, each of which acts as a trigger to send a batch of messages as arequest. At least one threshold must be positive nonzero.

func (BatchingSettingsProto)MarshalJSONadded inv0.235.0

func (sBatchingSettingsProto) MarshalJSON() ([]byte,error)

typeBilling

type Billing struct {// ConsumerDestinations: Billing configurations for sending metrics to the// consumer project. There can be multiple consumer destinations per service,// each one must have a different monitored resource type. A metric can be used// in at most one consumer destination.ConsumerDestinations []*BillingDestination `json:"consumerDestinations,omitempty"`// ForceSendFields is a list of field names (e.g. "ConsumerDestinations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConsumerDestinations") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Billing: Billing related configuration of the service. The following exampleshows how to configure monitored resources and metrics for billing,`consumer_destinations` is the only supported destination and the monitoredresources need at least one label key `cloud.googleapis.com/location` toindicate the location of the billing usage, using different monitoredresources between monitoring and billing is recommended so they can beevolved independently: monitored_resources: - type:library.googleapis.com/billing_branch labels: - key:cloud.googleapis.com/location description: | Predefined label to supportbilling location restriction. - key: city description: | Custom label todefine the city where the library branch is located in. - key: namedescription: Custom label to define the name of the library branch. metrics:- name: library.googleapis.com/book/borrowed_count metric_kind: DELTAvalue_type: INT64 unit: "1" billing: consumer_destinations: -monitored_resource: library.googleapis.com/billing_branch metrics: -library.googleapis.com/book/borrowed_count

func (Billing)MarshalJSON

func (sBilling) MarshalJSON() ([]byte,error)

typeBillingDestination

type BillingDestination struct {// Metrics: Names of the metrics to report to this billing destination. Each// name must be defined in Service.metrics section.Metrics []string `json:"metrics,omitempty"`// MonitoredResource: The monitored resource type. The type must be defined in// Service.monitored_resources section.MonitoredResourcestring `json:"monitoredResource,omitempty"`// ForceSendFields is a list of field names (e.g. "Metrics") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Metrics") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BillingDestination: Configuration of a specific billing destination(Currently only support bill against consumer project).

func (BillingDestination)MarshalJSON

func (sBillingDestination) MarshalJSON() ([]byte,error)

typeClientLibrarySettingsadded inv0.104.0

type ClientLibrarySettings struct {// CppSettings: Settings for C++ client libraries.CppSettings *CppSettings `json:"cppSettings,omitempty"`// DotnetSettings: Settings for .NET client libraries.DotnetSettings *DotnetSettings `json:"dotnetSettings,omitempty"`// GoSettings: Settings for Go client libraries.GoSettings *GoSettings `json:"goSettings,omitempty"`// JavaSettings: Settings for legacy Java features, supported in the Service// YAML.JavaSettings *JavaSettings `json:"javaSettings,omitempty"`// LaunchStage: Launch stage of this version of the API.//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud// Platform Subject to the Deprecation// Policy](https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// NodeSettings: Settings for Node client libraries.NodeSettings *NodeSettings `json:"nodeSettings,omitempty"`// PhpSettings: Settings for PHP client libraries.PhpSettings *PhpSettings `json:"phpSettings,omitempty"`// PythonSettings: Settings for Python client libraries.PythonSettings *PythonSettings `json:"pythonSettings,omitempty"`// RestNumericEnums: When using transport=rest, the client request will encode// enums as numbers rather than strings.RestNumericEnumsbool `json:"restNumericEnums,omitempty"`// RubySettings: Settings for Ruby client libraries.RubySettings *RubySettings `json:"rubySettings,omitempty"`// 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".Versionstring `json:"version,omitempty"`// ForceSendFields is a list of field names (e.g. "CppSettings") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CppSettings") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ClientLibrarySettings: Details about how and where to publish clientlibraries.

func (ClientLibrarySettings)MarshalJSONadded inv0.104.0

func (sClientLibrarySettings) MarshalJSON() ([]byte,error)

typeCommonLanguageSettingsadded inv0.104.0

type CommonLanguageSettings struct {// Destinations: The destination where API teams want this client library to be// published.//// Possible values://   "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED" - Client libraries will neither// be generated nor published to package managers.//   "GITHUB" - Generate the client library in a repo under// github.com/googleapis, but don't publish it to package managers.//   "PACKAGE_MANAGER" - Publish the library to package managers like nuget.org// and npmjs.com.Destinations []string `json:"destinations,omitempty"`// ReferenceDocsUri: Link to automatically generated reference documentation.// Example:https://cloud.google.com/nodejs/docs/reference/asset/latestReferenceDocsUristring `json:"referenceDocsUri,omitempty"`// SelectiveGapicGeneration: Configuration for which RPCs should be generated// in the GAPIC client.SelectiveGapicGeneration *SelectiveGapicGeneration `json:"selectiveGapicGeneration,omitempty"`// ForceSendFields is a list of field names (e.g. "Destinations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Destinations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CommonLanguageSettings: Required information for every language.

func (CommonLanguageSettings)MarshalJSONadded inv0.104.0

func (sCommonLanguageSettings) MarshalJSON() ([]byte,error)

typeConsumerPolicyadded inv0.118.0

type ConsumerPolicy struct {// Annotations: Optional. Annotations is an unstructured key-value map stored// with a policy that may be set by external tools to store and retrieve// arbitrary metadata. They are not queryable and should be preserved when// modifying objects. AIP-128 (https://google.aip.dev/128#annotations)Annotations map[string]string `json:"annotations,omitempty"`// EnableRules: Enable rules define usable services and service groups.EnableRules []*EnableRule `json:"enableRules,omitempty"`// Etag: An opaque tag indicating the current version of the policy, used for// concurrency control.Etagstring `json:"etag,omitempty"`// Name: Output only. The resource name of the policy. We only allow consumer// policy name as `default` for now: `projects/12345/consumerPolicies/default`,// `folders/12345/consumerPolicies/default`,// `organizations/12345/consumerPolicies/default`.Namestring `json:"name,omitempty"`// UpdateTime: The last-modified time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Annotations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Annotations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ConsumerPolicy: Consumer Policy is a set of rules that define what servicesor service groups can be used for a cloud resource hierarchy.

func (ConsumerPolicy)MarshalJSONadded inv0.118.0

func (sConsumerPolicy) MarshalJSON() ([]byte,error)

typeConsumerQuotaLimitadded inv0.21.0

type ConsumerQuotaLimit struct {// AllowsAdminOverrides: Whether admin overrides are allowed on this limitAllowsAdminOverridesbool `json:"allowsAdminOverrides,omitempty"`// IsPrecise: Whether this limit is precise or imprecise.IsPrecisebool `json:"isPrecise,omitempty"`// Metric: The name of the parent metric of this limit. An example name would// be: `compute.googleapis.com/cpus`Metricstring `json:"metric,omitempty"`// Name: The resource name of the quota limit. An example name would be:// `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.go// ogleapis.com%2Fcpus/limits/%2Fproject%2Fregion` The resource name is// intended to be opaque and should not be parsed for its component strings,// since its representation could change in the future.Namestring `json:"name,omitempty"`// QuotaBuckets: Summary of the enforced quota buckets, organized by quota// dimension, ordered from least specific to most specific (for example, the// global default bucket, with no quota dimensions, will always appear first).QuotaBuckets []*QuotaBucket `json:"quotaBuckets,omitempty"`// SupportedLocations: List of all supported locations. This field is present// only if the limit has a {region} or {zone} dimension.SupportedLocations []string `json:"supportedLocations,omitempty"`// Unit: The limit unit. An example unit would be `1/{project}/{region}` Note// that `{project}` and `{region}` are not placeholders in this example; the// literal characters `{` and `}` occur in the string.Unitstring `json:"unit,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AllowsAdminOverrides") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowsAdminOverrides") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ConsumerQuotaLimit: Consumer quota settings for a quota limit.

func (ConsumerQuotaLimit)MarshalJSONadded inv0.21.0

func (sConsumerQuotaLimit) MarshalJSON() ([]byte,error)

typeConsumerQuotaMetricadded inv0.21.0

type ConsumerQuotaMetric struct {// ConsumerQuotaLimits: The consumer quota for each quota limit defined on the// metric.ConsumerQuotaLimits []*ConsumerQuotaLimit `json:"consumerQuotaLimits,omitempty"`// DescendantConsumerQuotaLimits: The quota limits targeting the descendant// containers of the consumer in request. If the consumer in request is of type// `organizations` or `folders`, the field will list per-project limits in the// metric; if the consumer in request is of type `project`, the field will be// empty. The `quota_buckets` field of each descendant consumer quota limit// will not be populated.DescendantConsumerQuotaLimits []*ConsumerQuotaLimit `json:"descendantConsumerQuotaLimits,omitempty"`// DisplayName: The display name of the metric. An example name would be:// `CPUs`DisplayNamestring `json:"displayName,omitempty"`// Metric: The name of the metric. An example name would be:// `compute.googleapis.com/cpus`Metricstring `json:"metric,omitempty"`// Name: The resource name of the quota settings on this metric for this// consumer. An example name would be:// `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.go// ogleapis.com%2Fcpus` The resource name is intended to be opaque and should// not be parsed for its component strings, since its representation could// change in the future.Namestring `json:"name,omitempty"`// Unit: The units in which the metric value is reported.Unitstring `json:"unit,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ConsumerQuotaLimits") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConsumerQuotaLimits") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ConsumerQuotaMetric: Consumer quota settings for a quota metric.

func (ConsumerQuotaMetric)MarshalJSONadded inv0.21.0

func (sConsumerQuotaMetric) MarshalJSON() ([]byte,error)

typeContentSecurityadded inv0.250.0

type ContentSecurity struct {// ContentSecurityProviders: List of content security providers that are// enabled for content scanning.ContentSecurityProviders []*ContentSecurityProvider `json:"contentSecurityProviders,omitempty"`// ForceSendFields is a list of field names (e.g. "ContentSecurityProviders")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ContentSecurityProviders") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ContentSecurity: ContentSecurity defines the content security related fieldsof a MCP policy.

func (ContentSecurity)MarshalJSONadded inv0.250.0

func (sContentSecurity) MarshalJSON() ([]byte,error)

typeContentSecurityPolicyadded inv0.255.0

type ContentSecurityPolicy struct {// McpContentSecurity: mcp_content_security contains the content security// related settings at resource level for MCP traffic.McpContentSecurity *ContentSecurity `json:"mcpContentSecurity,omitempty"`// Name: Output only. The resource name of the policy. Only the `default`// policy is supported. We allow the following formats:// `projects/{PROJECT_NUMBER}/contentSecurityPolicies/default`,// `projects/{PROJECT_ID}/contentSecurityPolicies/default`, We only support// project level content security policy for now.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "McpContentSecurity") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "McpContentSecurity") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ContentSecurityPolicy: Content Security Policy contains the content securityrelated policy of a resource.

func (ContentSecurityPolicy)MarshalJSONadded inv0.255.0

func (sContentSecurityPolicy) MarshalJSON() ([]byte,error)

typeContentSecurityProvideradded inv0.250.0

type ContentSecurityProvider struct {// Name: Name of security service for content scanning, such as Google Cloud// Model Armor or supported third-party ISV solutions. If it is Google 1P// service, the name should be prefixed with `services/`. If it is a 3P// service, the format needs to be documented. The currently supported values// are: - `services/modelarmor.googleapis.com` for Google Cloud Model Armor.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ContentSecurityProvider: ContentSecurityProvider contains the name ofcontent security provider.

func (ContentSecurityProvider)MarshalJSONadded inv0.250.0

func (sContentSecurityProvider) MarshalJSON() ([]byte,error)

typeContext

type Context struct {// Rules: A list of RPC context rules that apply to individual API methods.// **NOTE:** All service configuration rules follow "last one wins" order.Rules []*ContextRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g. "Rules") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Rules") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Context: `Context` defines which contexts an API requests. Example: context:rules: - selector: "*" requested: - google.rpc.context.ProjectContext -google.rpc.context.OriginContext The above specifies that all methods in theAPI request `google.rpc.context.ProjectContext` and`google.rpc.context.OriginContext`. Available context types are defined inpackage `google.rpc.context`. This also provides mechanism to allowlist anyprotobuf message extension that can be sent in grpc metadata using“x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, listany service specific protobuf types that can appear in grpc metadata asfollows in your yaml file: Example: context: rules: - selector:"google.example.library.v1.LibraryService.CreateBook"allowed_request_extensions: - google.foo.v1.NewExtensionallowed_response_extensions: - google.foo.v1.NewExtension You can alsospecify extension ID instead of fully qualified extension name here.

func (Context)MarshalJSON

func (sContext) MarshalJSON() ([]byte,error)

typeContextRule

type ContextRule struct {// AllowedRequestExtensions: A list of full type names or extension IDs of// extensions allowed in grpc side channel from client to backend.AllowedRequestExtensions []string `json:"allowedRequestExtensions,omitempty"`// AllowedResponseExtensions: A list of full type names or extension IDs of// extensions allowed in grpc side channel from backend to client.AllowedResponseExtensions []string `json:"allowedResponseExtensions,omitempty"`// Provided: A list of full type names of provided contexts. It is used to// support propagating HTTP headers and ETags from the response extension.Provided []string `json:"provided,omitempty"`// Requested: A list of full type names of requested contexts, only the// requested context will be made available to the backend.Requested []string `json:"requested,omitempty"`// Selector: Selects the methods to which this rule applies. Refer to selector// for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowedRequestExtensions")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowedRequestExtensions") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ContextRule: A context rule provides information about the context for anindividual API element.

func (ContextRule)MarshalJSON

func (sContextRule) MarshalJSON() ([]byte,error)

typeControl

type Control struct {// Environment: The service controller environment to use. If empty, no control// plane feature (like quota and billing) will be enabled. The recommended// value for most services is servicecontrol.googleapis.comEnvironmentstring `json:"environment,omitempty"`// MethodPolicies: Defines policies applying to the API methods of the service.MethodPolicies []*MethodPolicy `json:"methodPolicies,omitempty"`// ForceSendFields is a list of field names (e.g. "Environment") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Environment") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Control: Selects and configures the service controller used by the service.Example: control: environment: servicecontrol.googleapis.com

func (Control)MarshalJSON

func (sControl) MarshalJSON() ([]byte,error)

typeCppSettingsadded inv0.104.0

type CppSettings struct {// Common: Some settings.Common *CommonLanguageSettings `json:"common,omitempty"`// ForceSendFields is a list of field names (e.g. "Common") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Common") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CppSettings: Settings for C++ client libraries.

func (CppSettings)MarshalJSONadded inv0.104.0

func (sCppSettings) MarshalJSON() ([]byte,error)

typeCreateAdminQuotaPolicyMetadataadded inv0.45.0

type CreateAdminQuotaPolicyMetadata struct {}

CreateAdminQuotaPolicyMetadata: Metadata message that provides informationsuch as progress, partial failures, and similar information on eachGetOperation call of LRO returned by CreateAdminQuotaPolicy.

typeCustomError

type CustomError struct {// Rules: The list of custom error rules that apply to individual API messages.// **NOTE:** All service configuration rules follow "last one wins" order.Rules []*CustomErrorRule `json:"rules,omitempty"`// Types: The list of custom error detail types, e.g.// 'google.foo.v1.CustomError'.Types []string `json:"types,omitempty"`// ForceSendFields is a list of field names (e.g. "Rules") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Rules") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CustomError: Customize service error responses. For example, list anyservice specific protobuf types that can appear in error detail lists oferror responses. Example: custom_error: types: - google.foo.v1.CustomError -google.foo.v1.AnotherError

func (CustomError)MarshalJSON

func (sCustomError) MarshalJSON() ([]byte,error)

typeCustomErrorRule

type CustomErrorRule struct {// IsErrorType: Mark this message as possible payload in error response.// Otherwise, objects of this type will be filtered when they appear in error// payload.IsErrorTypebool `json:"isErrorType,omitempty"`// Selector: Selects messages to which this rule applies. Refer to selector for// syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "IsErrorType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IsErrorType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CustomErrorRule: A custom error rule.

func (CustomErrorRule)MarshalJSON

func (sCustomErrorRule) MarshalJSON() ([]byte,error)

typeCustomHttpPattern

type CustomHttpPattern struct {// Kind: The name of this custom HTTP verb.Kindstring `json:"kind,omitempty"`// Path: The path matched by this custom verb.Pathstring `json:"path,omitempty"`// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Kind") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CustomHttpPattern: A custom pattern is used for defining custom HTTP verb.

func (CustomHttpPattern)MarshalJSON

func (sCustomHttpPattern) MarshalJSON() ([]byte,error)

typeDeleteAdminQuotaPolicyMetadataadded inv0.45.0

type DeleteAdminQuotaPolicyMetadata struct {}

DeleteAdminQuotaPolicyMetadata: Metadata message that provides informationsuch as progress, partial failures, and similar information on eachGetOperation call of LRO returned by DeleteAdminQuotaPolicy.

typeDisableServiceRequest

type DisableServiceRequest struct {}

DisableServiceRequest: Request message for the `DisableService` method.

typeDisableServiceResponse

type DisableServiceResponse struct {// Service: The new state of the service after disabling.Service *GoogleApiServiceusageV1Service `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "Service") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Service") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DisableServiceResponse: Response message for the `DisableService` method.This response message is assigned to the `response` field of the returnedOperation when that operation is done.

func (DisableServiceResponse)MarshalJSON

func (sDisableServiceResponse) MarshalJSON() ([]byte,error)

typeDocumentation

type Documentation struct {// AdditionalIamInfo: Optional information about the IAM configuration. This is// typically used to link to documentation about a product's IAM roles and// permissions.AdditionalIamInfostring `json:"additionalIamInfo,omitempty"`// DocumentationRootUrl: The URL to the root of documentation.DocumentationRootUrlstring `json:"documentationRootUrl,omitempty"`// Overview: Declares a single overview page. For example: documentation:// summary: ... overview: (== include overview.md ==) This is a shortcut for// the following declaration (using pages style): documentation: summary: ...// pages: - name: Overview content: (== include overview.md ==) Note: you// cannot specify both `overview` field and `pages` field.Overviewstring `json:"overview,omitempty"`// Pages: The top level pages for the documentation set.Pages []*Page `json:"pages,omitempty"`// Rules: A list of documentation rules that apply to individual API elements.// **NOTE:** All service configuration rules follow "last one wins" order.Rules []*DocumentationRule `json:"rules,omitempty"`// SectionOverrides: Specifies section and content to override the boilerplate// content. Currently overrides following sections: 1.// rest.service.client_librariesSectionOverrides []*Page `json:"sectionOverrides,omitempty"`// ServiceRootUrl: Specifies the service root url if the default one (the// service name from the yaml file) is not suitable. This can be seen in any// fully specified service urls as well as sections that show a base that other// urls are relative to.ServiceRootUrlstring `json:"serviceRootUrl,omitempty"`// Summary: A short description of what the service does. The summary must be// plain text. It becomes the overview of the service displayed in Google Cloud// Console. NOTE: This field is equivalent to the standard field `description`.Summarystring `json:"summary,omitempty"`// ForceSendFields is a list of field names (e.g. "AdditionalIamInfo") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdditionalIamInfo") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Documentation: `Documentation` provides the information for describing aservice. Example: documentation: summary: > The Google Calendar API givesaccess to most calendar features. pages: - name: Overview content: (==include google/foo/overview.md ==) - name: Tutorial content: (== includegoogle/foo/tutorial.md ==) subpages: - name: Java content: (== includegoogle/foo/tutorial_java.md ==) rules: - selector:google.calendar.Calendar.Get description: > ... - selector:google.calendar.Calendar.Put description: > ... Documentation is provided inmarkdown syntax. In addition to standard markdown features, definitionlists, tables and fenced code blocks are supported. Section headers can beprovided and are interpreted relative to the section nesting of the contextwhere a documentation fragment is embedded. Documentation from the IDL ismerged with documentation defined via the config at normalization time,where documentation provided by config rules overrides IDL provided. Anumber of constructs specific to the API platform are supported indocumentation text. In order to reference a proto element, the followingnotation can be used: [fully.qualified.proto.name][] To override the displaytext used for the link, this can be used: [displaytext][fully.qualified.proto.name] Text can be excluded from doc using thefollowing notation: (-- internal comment --) A few directives are availablein documentation. Note that directives must appear on a single line to beproperly identified. The `include` directive includes a markdown file froman external source: (== include path/to/file ==) The `resource_for`directive marks a message to be the resource of a collection in REST view.If it is not specified, tools attempt to infer the resource from theoperations in a collection: (== resource_for v1.shelves.books ==) Thedirective `suppress_warning` does not directly affect documentation and isdocumented together with service config validation.

func (Documentation)MarshalJSON

func (sDocumentation) MarshalJSON() ([]byte,error)

typeDocumentationRule

type DocumentationRule struct {// DeprecationDescription: Deprecation description of the selected element(s).// It can be provided if an element is marked as `deprecated`.DeprecationDescriptionstring `json:"deprecationDescription,omitempty"`// Description: Description of the selected proto element (e.g. a message, a// method, a 'service' definition, or a field). Defaults to leading & trailing// comments taken from the proto source definition of the proto element.Descriptionstring `json:"description,omitempty"`// DisableReplacementWords: String of comma or space separated case-sensitive// words for which method/field name replacement will be disabled.DisableReplacementWordsstring `json:"disableReplacementWords,omitempty"`// Selector: The selector is a comma-separated list of patterns for any element// such as a method, a field, an enum value. Each pattern is a qualified name// of the element which may end in "*", indicating a wildcard. Wildcards are// only allowed at the end and for a whole component of the qualified name,// i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match// one or more components. To specify a default for all applicable elements,// the whole pattern "*" is used.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "DeprecationDescription") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeprecationDescription") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DocumentationRule: A documentation rule provides information aboutindividual API elements.

func (DocumentationRule)MarshalJSON

func (sDocumentationRule) MarshalJSON() ([]byte,error)

typeDotnetSettingsadded inv0.104.0

type DotnetSettings struct {// Common: Some settings.Common *CommonLanguageSettings `json:"common,omitempty"`// ForcedNamespaceAliases: Namespaces which must be aliased in snippets due to// a known (but non-generator-predictable) naming collisionForcedNamespaceAliases []string `json:"forcedNamespaceAliases,omitempty"`// 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.HandwrittenSignatures []string `json:"handwrittenSignatures,omitempty"`// 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"IgnoredResources []string `json:"ignoredResources,omitempty"`// 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"RenamedResources map[string]string `json:"renamedResources,omitempty"`// 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.RenamedServices map[string]string `json:"renamedServices,omitempty"`// ForceSendFields is a list of field names (e.g. "Common") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Common") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DotnetSettings: Settings for Dotnet client libraries.

func (DotnetSettings)MarshalJSONadded inv0.104.0

func (sDotnetSettings) MarshalJSON() ([]byte,error)

typeEmpty

type Empty struct {}

Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeEnableFailure

type EnableFailure struct {// ErrorMessage: An error message describing why the service could not be// enabled.ErrorMessagestring `json:"errorMessage,omitempty"`// ServiceId: The service id of a service that could not be enabled.ServiceIdstring `json:"serviceId,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorMessage") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorMessage") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

EnableFailure: Provides error messages for the failing services.

func (EnableFailure)MarshalJSON

func (sEnableFailure) MarshalJSON() ([]byte,error)

typeEnableRuleadded inv0.118.0

type EnableRule struct {// EnableType: Client and resource project enable type.//// Possible values://   "ENABLE_TYPE_UNSPECIFIED" - Unspecified enable type, which means enabled// as both client and resource project.//   "CLIENT" - Enable all clients under the CRM node specified by// `ConsumerPolicy.name` to use the listed services. A client can be an API// key, an OAuth client, or a service account.//   "RESOURCE" - Enable resources in the list services to be created and used// under the CRM node specified by the `ConsumerPolicy.name`.//   "V1_COMPATIBLE" - Activation made by Service Usage v1 API. This will be// how consumers differentiate between policy changes made by v1 and v2 clients// and understand what is actually possible based on those different policies.EnableTypestring `json:"enableType,omitempty"`// Groups: DEPRECATED: Please use field `values`. Service group should have// prefix `groups/`. The names of the service groups that are enabled (Not// Implemented). Example: `groups/googleServices`.Groups []string `json:"groups,omitempty"`// Services: DEPRECATED: Please use field `values`. Service should have prefix// `services/`. The names of the services that are enabled. Example:// `storage.googleapis.com`.Services []string `json:"services,omitempty"`// Values: The names of the services or service groups that are enabled.// Example: `services/storage.googleapis.com`, `groups/googleServices`,// `groups/allServices`.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "EnableType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EnableType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

EnableRule: The consumer policy rule that defines usable services andservice groups.

func (EnableRule)MarshalJSONadded inv0.118.0

func (sEnableRule) MarshalJSON() ([]byte,error)

typeEnableServiceRequest

type EnableServiceRequest struct {}

EnableServiceRequest: Request message for the `EnableService` method.

typeEnableServiceResponse

type EnableServiceResponse struct {// Service: The new state of the service after enabling.Service *GoogleApiServiceusageV1Service `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "Service") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Service") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

EnableServiceResponse: Response message for the `EnableService` method. Thisresponse message is assigned to the `response` field of the returnedOperation when that operation is done.

func (EnableServiceResponse)MarshalJSON

func (sEnableServiceResponse) MarshalJSON() ([]byte,error)

typeEndpoint

type Endpoint struct {// Aliases: Aliases for this endpoint, these will be served by the same UrlMap// as the parent endpoint, and will be provisioned in the GCP stack for the// Regional Endpoints.Aliases []string `json:"aliases,omitempty"`// AllowCors: Allowing CORS// (https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka// cross-domain traffic, would allow the backends served from this endpoint to// receive and respond to HTTP OPTIONS requests. The response will be used by// the browser to determine whether the subsequent cross-origin request is// allowed to proceed.AllowCorsbool `json:"allowCors,omitempty"`// Name: The canonical name of this endpoint.Namestring `json:"name,omitempty"`// Target: The specification of an Internet routable address of API frontend// that will handle requests to this API Endpoint// (https://cloud.google.com/apis/design/glossary). It should be either a valid// IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or// "myservice.appspot.com".Targetstring `json:"target,omitempty"`// ForceSendFields is a list of field names (e.g. "Aliases") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Aliases") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Endpoint: `Endpoint` describes a network address of a service that serves aset of APIs. It is commonly known as a service endpoint. A service mayexpose any number of service endpoints, and all service endpoints share thesame service definition, such as quota limits and monitoring metrics.Example: type: google.api.Service name: library-example.googleapis.comendpoints: # Declares network address`https://library-example.googleapis.com` # for service`library-example.googleapis.com`. The `https` scheme # is implicit for allservice endpoints. Other schemes may be # supported in the future. - name:library-example.googleapis.com allow_cors: false - name:content-staging-library-example.googleapis.com # Allows HTTP OPTIONS callsto be passed to the API frontend, for it # to decide whether the subsequentcross-origin request is allowed # to proceed. allow_cors: true

func (Endpoint)MarshalJSON

func (sEndpoint) MarshalJSON() ([]byte,error)

typeEnum

type Enum struct {// Edition: The source edition string, only valid when syntax is// SYNTAX_EDITIONS.Editionstring `json:"edition,omitempty"`// Enumvalue: Enum value definitions.Enumvalue []*EnumValue `json:"enumvalue,omitempty"`// Name: Enum type name.Namestring `json:"name,omitempty"`// Options: Protocol buffer options.Options []*Option `json:"options,omitempty"`// SourceContext: The source context.SourceContext *SourceContext `json:"sourceContext,omitempty"`// Syntax: The source syntax.//// Possible values://   "SYNTAX_PROTO2" - Syntax `proto2`.//   "SYNTAX_PROTO3" - Syntax `proto3`.//   "SYNTAX_EDITIONS" - Syntax `editions`.Syntaxstring `json:"syntax,omitempty"`// ForceSendFields is a list of field names (e.g. "Edition") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Edition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Enum: Enum type definition. New usages of this message as an alternative toEnumDescriptorProto are strongly discouraged. This message does notreliability preserve all information necessary to model the schema andpreserve semantics. Instead make use of FileDescriptorSet which preservesthe necessary information.

func (Enum)MarshalJSON

func (sEnum) MarshalJSON() ([]byte,error)

typeEnumValue

type EnumValue struct {// Name: Enum value name.Namestring `json:"name,omitempty"`// Number: Enum value number.Numberint64 `json:"number,omitempty"`// Options: Protocol buffer options.Options []*Option `json:"options,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

EnumValue: Enum value definition. New usages of this message as analternative to EnumValueDescriptorProto are strongly discouraged. Thismessage does not reliability preserve all information necessary to model theschema and preserve semantics. Instead make use of FileDescriptorSet whichpreserves the necessary information.

func (EnumValue)MarshalJSON

func (sEnumValue) MarshalJSON() ([]byte,error)

typeExperimentalFeaturesadded inv0.198.0

type ExperimentalFeatures struct {// ProtobufPythonicTypesEnabled: Enables generation of protobuf code using new// types that are more Pythonic which are included in `protobuf>=5.29.x`. This// feature will be enabled by default 1 month after launching the feature in// preview packages.ProtobufPythonicTypesEnabledbool `json:"protobufPythonicTypesEnabled,omitempty"`// RestAsyncIoEnabled: Enables generation of asynchronous REST clients if// `rest` transport is enabled. By default, asynchronous REST clients will not// be generated. This feature will be enabled by default 1 month after// launching the feature in preview packages.RestAsyncIoEnabledbool `json:"restAsyncIoEnabled,omitempty"`// UnversionedPackageDisabled: Disables generation of an unversioned Python// package for this client library. This means that the module names will need// to be versioned in import statements. For example `import// google.cloud.library_v2` instead of `import google.cloud.library`.UnversionedPackageDisabledbool `json:"unversionedPackageDisabled,omitempty"`// ForceSendFields is a list of field names (e.g.// "ProtobufPythonicTypesEnabled") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProtobufPythonicTypesEnabled") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ExperimentalFeatures: Experimental features to be included during clientlibrary generation. These fields will be deprecated once the featuregraduates and is enabled by default.

func (ExperimentalFeatures)MarshalJSONadded inv0.198.0

func (sExperimentalFeatures) MarshalJSON() ([]byte,error)

typeField

type Field struct {// Cardinality: The field cardinality.//// Possible values://   "CARDINALITY_UNKNOWN" - For fields with unknown cardinality.//   "CARDINALITY_OPTIONAL" - For optional fields.//   "CARDINALITY_REQUIRED" - For required fields. Proto2 syntax only.//   "CARDINALITY_REPEATED" - For repeated fields.Cardinalitystring `json:"cardinality,omitempty"`// DefaultValue: The string value of the default value of this field. Proto2// syntax only.DefaultValuestring `json:"defaultValue,omitempty"`// JsonName: The field JSON name.JsonNamestring `json:"jsonName,omitempty"`// Kind: The field type.//// Possible values://   "TYPE_UNKNOWN" - Field type unknown.//   "TYPE_DOUBLE" - Field type double.//   "TYPE_FLOAT" - Field type float.//   "TYPE_INT64" - Field type int64.//   "TYPE_UINT64" - Field type uint64.//   "TYPE_INT32" - Field type int32.//   "TYPE_FIXED64" - Field type fixed64.//   "TYPE_FIXED32" - Field type fixed32.//   "TYPE_BOOL" - Field type bool.//   "TYPE_STRING" - Field type string.//   "TYPE_GROUP" - Field type group. Proto2 syntax only, and deprecated.//   "TYPE_MESSAGE" - Field type message.//   "TYPE_BYTES" - Field type bytes.//   "TYPE_UINT32" - Field type uint32.//   "TYPE_ENUM" - Field type enum.//   "TYPE_SFIXED32" - Field type sfixed32.//   "TYPE_SFIXED64" - Field type sfixed64.//   "TYPE_SINT32" - Field type sint32.//   "TYPE_SINT64" - Field type sint64.Kindstring `json:"kind,omitempty"`// Name: The field name.Namestring `json:"name,omitempty"`// Number: The field number.Numberint64 `json:"number,omitempty"`// OneofIndex: The index of the field type in `Type.oneofs`, for message or// enumeration types. The first type has index 1; zero means the type is not in// the list.OneofIndexint64 `json:"oneofIndex,omitempty"`// Options: The protocol buffer options.Options []*Option `json:"options,omitempty"`// Packed: Whether to use alternative packed wire representation.Packedbool `json:"packed,omitempty"`// TypeUrl: The field type URL, without the scheme, for message or enumeration// types. Example: "type.googleapis.com/google.protobuf.Timestamp".TypeUrlstring `json:"typeUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "Cardinality") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cardinality") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Field: A single field of a message type. New usages of this message as analternative to FieldDescriptorProto are strongly discouraged. This messagedoes not reliability preserve all information necessary to model the schemaand preserve semantics. Instead make use of FileDescriptorSet whichpreserves the necessary information.

func (Field)MarshalJSON

func (sField) MarshalJSON() ([]byte,error)

typeFieldPolicyadded inv0.133.0

type FieldPolicy struct {// ResourcePermission: Specifies the required permission(s) for the resource// referred to by the field. It requires the field contains a valid resource// reference, and the request must pass the permission checks to proceed. For// example, "resourcemanager.projects.get".ResourcePermissionstring `json:"resourcePermission,omitempty"`// ResourceType: Specifies the resource type for the resource referred to by// the field.ResourceTypestring `json:"resourceType,omitempty"`// Selector: Selects one or more request or response message fields to apply// this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the// selector must be left as empty. The service config generator will// automatically fill the correct value. When a `FieldPolicy` is used in// service config, the selector must be a comma-separated string with valid// request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "ResourcePermission") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResourcePermission") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

FieldPolicy: Google API Policy Annotation This message defines a simple APIpolicy annotation that can be used to annotate API request and responsemessage fields with applicable policies. One field may have multipleapplicable policies that must all be satisfied before a request can beprocessed. This policy annotation is used to generate the overall policythat will be used for automatic runtime policy enforcement and documentationgeneration.

func (FieldPolicy)MarshalJSONadded inv0.133.0

func (sFieldPolicy) MarshalJSON() ([]byte,error)

typeGetServiceIdentityMetadataadded inv0.45.0

type GetServiceIdentityMetadata struct {}

GetServiceIdentityMetadata: Metadata for the `GetServiceIdentity` method.

typeGetServiceIdentityResponseadded inv0.11.0

type GetServiceIdentityResponse struct {// Identity: Service identity that service producer can use to access consumer// resources. If exists is true, it contains email and unique_id. If exists is// false, it contains pre-constructed email and empty unique_id.Identity *ServiceIdentity `json:"identity,omitempty"`// State: Service identity state.//// Possible values://   "IDENTITY_STATE_UNSPECIFIED" - Default service identity state. This value// is used if the state is omitted.//   "ACTIVE" - Service identity has been created and can be used.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "Identity") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Identity") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GetServiceIdentityResponse: Response message for getting service identity.

func (GetServiceIdentityResponse)MarshalJSONadded inv0.11.0

func (sGetServiceIdentityResponse) MarshalJSON() ([]byte,error)

typeGoSettingsadded inv0.104.0

type GoSettings struct {// Common: Some settings.Common *CommonLanguageSettings `json:"common,omitempty"`// 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. Example: publishing: go_settings:// renamed_services: Publisher: TopicAdminRenamedServices map[string]string `json:"renamedServices,omitempty"`// ForceSendFields is a list of field names (e.g. "Common") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Common") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoSettings: Settings for Go client libraries.

func (GoSettings)MarshalJSONadded inv0.104.0

func (sGoSettings) MarshalJSON() ([]byte,error)

typeGoogleApiService

type GoogleApiService struct {// Apis: A list of API interfaces exported by this service. Only the `name`// field of the google.protobuf.Api needs to be provided by the configuration// author, as the remaining fields will be derived from the IDL during the// normalization process. It is an error to specify an API interface here which// cannot be resolved against the associated IDL files.Apis []*Api `json:"apis,omitempty"`// Aspects: Configuration aspects. This is a repeated field to allow multiple// aspects to be configured. The kind field in each ConfigAspect specifies the// type of aspect. The spec field contains the configuration for that aspect.// The schema for the spec field is defined by the backend service owners.Aspects []*Aspect `json:"aspects,omitempty"`// Authentication: Auth configuration.Authentication *Authentication `json:"authentication,omitempty"`// Backend: API backend configuration.Backend *Backend `json:"backend,omitempty"`// Billing: Billing configuration.Billing *Billing `json:"billing,omitempty"`// ConfigVersion: Obsolete. Do not use. This field has no semantic meaning. The// service config compiler always sets this field to `3`.ConfigVersionint64 `json:"configVersion,omitempty"`// Context: Context configuration.Context *Context `json:"context,omitempty"`// Control: Configuration for the service control plane.Control *Control `json:"control,omitempty"`// CustomError: Custom error configuration.CustomError *CustomError `json:"customError,omitempty"`// Documentation: Additional API documentation.Documentation *Documentation `json:"documentation,omitempty"`// Endpoints: Configuration for network endpoints. If this is empty, then an// endpoint with the same name as the service is automatically generated to// service all defined APIs.Endpoints []*Endpoint `json:"endpoints,omitempty"`// Enums: A list of all enum types included in this API service. Enums// referenced directly or indirectly by the `apis` are automatically included.// Enums which are not referenced but shall be included should be listed here// by name by the configuration author. Example: enums: - name:// google.someapi.v1.SomeEnumEnums []*Enum `json:"enums,omitempty"`// Http: HTTP configuration.Http *Http `json:"http,omitempty"`// Id: A unique ID for a specific instance of this message, typically assigned// by the client for tracking purpose. Must be no longer than 63 characters and// only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the// server may choose to generate one instead.Idstring `json:"id,omitempty"`// Logging: Logging configuration.Logging *Logging `json:"logging,omitempty"`// Logs: Defines the logs used by this service.Logs []*LogDescriptor `json:"logs,omitempty"`// Metrics: Defines the metrics used by this service.Metrics []*MetricDescriptor `json:"metrics,omitempty"`// MonitoredResources: Defines the monitored resources used by this service.// This is required by the Service.monitoring and Service.logging// configurations.MonitoredResources []*MonitoredResourceDescriptor `json:"monitoredResources,omitempty"`// Monitoring: Monitoring configuration.Monitoring *Monitoring `json:"monitoring,omitempty"`// Name: The service name, which is a DNS-like logical identifier for the// service, such as `calendar.googleapis.com`. The service name typically goes// through DNS verification to make sure the owner of the service also owns the// DNS name.Namestring `json:"name,omitempty"`// ProducerProjectId: The Google project that owns this service.ProducerProjectIdstring `json:"producerProjectId,omitempty"`// Publishing: Settings for Google Cloud Client libraries// (https://cloud.google.com/apis/docs/cloud-client-libraries) generated from// APIs defined as protocol buffers.Publishing *Publishing `json:"publishing,omitempty"`// Quota: Quota configuration.Quota *Quota `json:"quota,omitempty"`// SourceInfo: Output only. The source information for this configuration if// available.SourceInfo *SourceInfo `json:"sourceInfo,omitempty"`// SystemParameters: System parameter configuration.SystemParameters *SystemParameters `json:"systemParameters,omitempty"`// SystemTypes: A list of all proto message types included in this API service.// It serves similar purpose as [google.api.Service.types], except that these// types are not needed by user-defined APIs. Therefore, they will not show up// in the generated discovery doc. This field should only be used to define// system APIs in ESF.SystemTypes []*Type `json:"systemTypes,omitempty"`// Title: The product title for this service, it is the name displayed in// Google Cloud Console.Titlestring `json:"title,omitempty"`// Types: A list of all proto message types included in this API service. Types// referenced directly or indirectly by the `apis` are automatically included.// Messages which are not referenced but shall be included, such as types used// by the `google.protobuf.Any` type, should be listed here by name by the// configuration author. Example: types: - name: google.protobuf.Int32Types []*Type `json:"types,omitempty"`// Usage: Configuration controlling usage of this service.Usage *Usage `json:"usage,omitempty"`// ForceSendFields is a list of field names (e.g. "Apis") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Apis") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiService: `Service` is the root object of Google API serviceconfiguration (service config). It describes the basic information about alogical service, such as the service name and the user-facing title, anddelegates other aspects to sub-sections. Each sub-section is either a protomessage or a repeated proto message that configures a specific aspect, suchas auth. For more information, see each proto message definition. Example:type: google.api.Service name: calendar.googleapis.com title: GoogleCalendar API apis: - name: google.calendar.v3.Calendar visibility: rules: -selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: -selector: "google.calendar.v3.*" address: calendar.example.comauthentication: providers: - id: google_calendar_auth jwks_uri:https://www.googleapis.com/oauth2/v1/certs issuer:https://securetoken.google.com rules: - selector: "*" requirements:provider_id: google_calendar_auth

func (GoogleApiService)MarshalJSON

func (sGoogleApiService) MarshalJSON() ([]byte,error)

typeGoogleApiServiceusageV1OperationMetadata

type GoogleApiServiceusageV1OperationMetadata struct {// ResourceNames: The full name of the resources that this operation is// directly associated with.ResourceNames []string `json:"resourceNames,omitempty"`// ForceSendFields is a list of field names (e.g. "ResourceNames") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResourceNames") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV1OperationMetadata: The operation metadata returnedfor the batchend services operation.

func (GoogleApiServiceusageV1OperationMetadata)MarshalJSON

typeGoogleApiServiceusageV1Service

type GoogleApiServiceusageV1Service struct {// Config: The service configuration of the available service. Some fields may// be filtered out of the configuration in responses to the `ListServices`// method. These fields are present only in responses to the `GetService`// method.Config *GoogleApiServiceusageV1ServiceConfig `json:"config,omitempty"`// Name: The resource name of the consumer and service. A valid name would be:// - projects/123/services/serviceusage.googleapis.comNamestring `json:"name,omitempty"`// Parent: The resource name of the consumer. A valid name would be: -// projects/123Parentstring `json:"parent,omitempty"`// State: Whether or not the service has been enabled for use by the consumer.//// Possible values://   "STATE_UNSPECIFIED" - The default value, which indicates that the enabled// state of the service is unspecified or not meaningful. Currently, all// consumers other than projects (such as folders and organizations) are always// in this state.//   "DISABLED" - The service cannot be used by this consumer. It has either// been explicitly disabled, or has never been enabled.//   "ENABLED" - The service has been explicitly enabled for use by this// consumer.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "Config") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Config") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV1Service: A service that is available for use by theconsumer.

func (GoogleApiServiceusageV1Service)MarshalJSON

func (sGoogleApiServiceusageV1Service) MarshalJSON() ([]byte,error)

typeGoogleApiServiceusageV1ServiceConfig

type GoogleApiServiceusageV1ServiceConfig struct {// Apis: A list of API interfaces exported by this service. Contains only the// names, versions, and method names of the interfaces.Apis []*Api `json:"apis,omitempty"`// Authentication: Auth configuration. Contains only the OAuth rules.Authentication *Authentication `json:"authentication,omitempty"`// Documentation: Additional API documentation. Contains only the summary and// the documentation URL.Documentation *Documentation `json:"documentation,omitempty"`// Endpoints: Configuration for network endpoints. Contains only the names and// aliases of the endpoints.Endpoints []*Endpoint `json:"endpoints,omitempty"`// MonitoredResources: Defines the monitored resources used by this service.// This is required by the Service.monitoring and Service.logging// configurations.MonitoredResources []*MonitoredResourceDescriptor `json:"monitoredResources,omitempty"`// Monitoring: Monitoring configuration. This should not include the// 'producer_destinations' field.Monitoring *Monitoring `json:"monitoring,omitempty"`// Name: The DNS address at which this service is available. An example DNS// address would be: `calendar.googleapis.com`.Namestring `json:"name,omitempty"`// Quota: Quota configuration.Quota *Quota `json:"quota,omitempty"`// Title: The product title for this service.Titlestring `json:"title,omitempty"`// Usage: Configuration controlling usage of this service.Usage *Usage `json:"usage,omitempty"`// ForceSendFields is a list of field names (e.g. "Apis") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Apis") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV1ServiceConfig: The configuration of the service.

func (GoogleApiServiceusageV1ServiceConfig)MarshalJSON

typeGoogleApiServiceusageV1beta1GetServiceIdentityResponseadded inv0.12.0

type GoogleApiServiceusageV1beta1GetServiceIdentityResponse struct {// Identity: Service identity that service producer can use to access consumer// resources. If exists is true, it contains email and unique_id. If exists is// false, it contains pre-constructed email and empty unique_id.Identity *GoogleApiServiceusageV1beta1ServiceIdentity `json:"identity,omitempty"`// State: Service identity state.//// Possible values://   "IDENTITY_STATE_UNSPECIFIED" - Default service identity state. This value// is used if the state is omitted.//   "ACTIVE" - Service identity has been created and can be used.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "Identity") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Identity") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV1beta1GetServiceIdentityResponse: Response message forgetting service identity.

func (GoogleApiServiceusageV1beta1GetServiceIdentityResponse)MarshalJSONadded inv0.12.0

typeGoogleApiServiceusageV1beta1ServiceIdentityadded inv0.12.0

type GoogleApiServiceusageV1beta1ServiceIdentity struct {// Email: The email address of the service account that a service producer// would use to access consumer resources.Emailstring `json:"email,omitempty"`// UniqueId: The unique and stable id of the service account.//https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccountUniqueIdstring `json:"uniqueId,omitempty"`// ForceSendFields is a list of field names (e.g. "Email") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Email") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV1beta1ServiceIdentity: Service identity for a service.This is the identity that service producer should use to access consumerresources.

func (GoogleApiServiceusageV1beta1ServiceIdentity)MarshalJSONadded inv0.12.0

typeGoogleApiServiceusageV2alphaConsumerPolicyadded inv0.151.0

type GoogleApiServiceusageV2alphaConsumerPolicy struct {// Annotations: Optional. Annotations is an unstructured key-value map stored// with a policy that may be set by external tools to store and retrieve// arbitrary metadata. They are not queryable and should be preserved when// modifying objects. AIP-128 (https://google.aip.dev/128#annotations)Annotations map[string]string `json:"annotations,omitempty"`// CreateTime: Output only. The time the policy was created. For singleton// policies, this is the first touch of the policy.CreateTimestring `json:"createTime,omitempty"`// EnableRules: Enable rules define usable services, groups, and categories.// There can currently be at most one `EnableRule`. This restriction will be// lifted in later releases.EnableRules []*GoogleApiServiceusageV2alphaEnableRule `json:"enableRules,omitempty"`// Etag: Output only. An opaque tag indicating the current version of the// policy, used for concurrency control.Etagstring `json:"etag,omitempty"`// Name: Output only. The resource name of the policy. Only the `default`// policy is supported: `projects/12345/consumerPolicies/default`,// `folders/12345/consumerPolicies/default`,// `organizations/12345/consumerPolicies/default`.Namestring `json:"name,omitempty"`// UpdateTime: Output only. The time the policy was last updated.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Annotations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Annotations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV2alphaConsumerPolicy: Consumer Policy is a set ofrules that define what services or service groups can be used for a cloudresource hierarchy.

func (GoogleApiServiceusageV2alphaConsumerPolicy)MarshalJSONadded inv0.151.0

typeGoogleApiServiceusageV2alphaEnableRuleadded inv0.151.0

type GoogleApiServiceusageV2alphaEnableRule struct {// Services: The names of the services that are enabled. Example:// `services/storage.googleapis.com`.Services []string `json:"services,omitempty"`// ForceSendFields is a list of field names (e.g. "Services") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Services") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV2alphaEnableRule: The consumer policy rule thatdefines enabled services, groups, and categories.

func (GoogleApiServiceusageV2alphaEnableRule)MarshalJSONadded inv0.151.0

typeGoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadataadded inv0.151.0

type GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata struct {}

GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: Metadata for the`UpdateConsumerPolicy` method.

typeGoogleApiServiceusageV2betaAnalysisadded inv0.205.0

type GoogleApiServiceusageV2betaAnalysis struct {// AnalysisResult: Output only. Analysis result of updating a policy.AnalysisResult *GoogleApiServiceusageV2betaAnalysisResult `json:"analysisResult,omitempty"`// AnalysisType: Output only. The type of analysis.//// Possible values://   "ANALYSIS_TYPE_UNSPECIFIED" - Unspecified analysis type. Do not use.//   "ANALYSIS_TYPE_DEPENDENCY" - The analysis of service dependencies.//   "ANALYSIS_TYPE_RESOURCE_USAGE" - The analysis of service resource usage.AnalysisTypestring `json:"analysisType,omitempty"`// DisplayName: Output only. The user friendly display name of the analysis// type. E.g. service dependency analysis, service resource usage analysis,// etc.DisplayNamestring `json:"displayName,omitempty"`// Service: The names of the service that has analysis result of warnings or// blockers. Example: `services/storage.googleapis.com`.Servicestring `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "AnalysisResult") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AnalysisResult") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV2betaAnalysis: A message to group the analysisinformation.

func (GoogleApiServiceusageV2betaAnalysis)MarshalJSONadded inv0.205.0

typeGoogleApiServiceusageV2betaAnalysisResultadded inv0.205.0

type GoogleApiServiceusageV2betaAnalysisResult struct {// Blockers: Blocking information that would prevent the policy changes at// runtime.Blockers []*GoogleApiServiceusageV2betaImpact `json:"blockers,omitempty"`// Warnings: Warning information indicating that the policy changes might be// unsafe, but will not block the changes at runtime.Warnings []*GoogleApiServiceusageV2betaImpact `json:"warnings,omitempty"`// ForceSendFields is a list of field names (e.g. "Blockers") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Blockers") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV2betaAnalysisResult: An analysis result includingblockers and warnings.

func (GoogleApiServiceusageV2betaAnalysisResult)MarshalJSONadded inv0.205.0

typeGoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadataadded inv0.205.0

type GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata struct {}

GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata: Metadata for the`AnalyzeConsumerPolicy` method.

typeGoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponseadded inv0.205.0

type GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse struct {// Analysis: The list of analyses returned from performing the intended policy// update analysis. The analysis is grouped by service name and different// analysis types. The empty analysis list means that the consumer policy can// be updated without any warnings or blockers.Analysis []*GoogleApiServiceusageV2betaAnalysis `json:"analysis,omitempty"`// ForceSendFields is a list of field names (e.g. "Analysis") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Analysis") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse: The response ofanalyzing a consumer policy update.

func (GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse)MarshalJSONadded inv0.205.0

typeGoogleApiServiceusageV2betaConsumerPolicyadded inv0.205.0

type GoogleApiServiceusageV2betaConsumerPolicy struct {// CreateTime: Output only. The time the policy was created. For singleton// policies, this is the first touch of the policy.CreateTimestring `json:"createTime,omitempty"`// EnableRules: Enable rules define usable services, groups, and categories.// There can currently be at most one `EnableRule`. This restriction will be// lifted in later releases.EnableRules []*GoogleApiServiceusageV2betaEnableRule `json:"enableRules,omitempty"`// Etag: An opaque tag indicating the current version of the policy, used for// concurrency control.Etagstring `json:"etag,omitempty"`// Name: Output only. The resource name of the policy. Only the `default`// policy is supported: `projects/12345/consumerPolicies/default`,// `folders/12345/consumerPolicies/default`,// `organizations/12345/consumerPolicies/default`.Namestring `json:"name,omitempty"`// UpdateTime: Output only. The time the policy was last updated.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV2betaConsumerPolicy: Consumer Policy is a set of rulesthat define what services or service groups can be used for a cloud resourcehierarchy.

func (GoogleApiServiceusageV2betaConsumerPolicy)MarshalJSONadded inv0.205.0

typeGoogleApiServiceusageV2betaEnableRuleadded inv0.205.0

type GoogleApiServiceusageV2betaEnableRule struct {// Services: The names of the services that are enabled. Example:// `services/storage.googleapis.com`.Services []string `json:"services,omitempty"`// ForceSendFields is a list of field names (e.g. "Services") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Services") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV2betaEnableRule: The consumer policy rule that definesenabled services, groups, and categories.

func (GoogleApiServiceusageV2betaEnableRule)MarshalJSONadded inv0.205.0

typeGoogleApiServiceusageV2betaImpactadded inv0.205.0

type GoogleApiServiceusageV2betaImpact struct {// Detail: Output only. User friendly impact detail in a free form message.Detailstring `json:"detail,omitempty"`// ImpactType: Output only. The type of impact.//// Possible values://   "IMPACT_TYPE_UNSPECIFIED" - Reserved Blocks (Block n contains codes from// 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of// ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of// ANALYSIS_TYPE_RESOURCE_USAGE ...//   "DEPENDENCY_MISSING_DEPENDENCIES" - Block 1 - Impact Type of// ANALYSIS_TYPE_DEPENDENCYImpactTypestring `json:"impactType,omitempty"`// MissingDependency: Output only. This field will be populated only for the// `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example:// `services/compute.googleapis.com`. Impact.detail will be in format :// `missing service dependency: {missing_dependency}.`MissingDependencystring `json:"missingDependency,omitempty"`// ForceSendFields is a list of field names (e.g. "Detail") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Detail") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiServiceusageV2betaImpact: A message to group impacts of updating apolicy.

func (GoogleApiServiceusageV2betaImpact)MarshalJSONadded inv0.205.0

func (sGoogleApiServiceusageV2betaImpact) MarshalJSON() ([]byte,error)

typeGoogleApiServiceusageV2betaUpdateConsumerPolicyMetadataadded inv0.205.0

type GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata struct {}

GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata: Metadata for the`UpdateConsumerPolicy` method.

typeHttp

type Http struct {// FullyDecodeReservedExpansion: When set to true, URL path parameters will be// fully URI-decoded except in cases of single segment matches in reserved// expansion, where "%2F" will be left encoded. The default behavior is to not// decodeRFC 6570 reserved characters in multi segment matches.FullyDecodeReservedExpansionbool `json:"fullyDecodeReservedExpansion,omitempty"`// Rules: A list of HTTP configuration rules that apply to individual API// methods. **NOTE:** All service configuration rules follow "last one wins"// order.Rules []*HttpRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g.// "FullyDecodeReservedExpansion") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FullyDecodeReservedExpansion") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Http: Defines the HTTP configuration for an API service. It contains a listof HttpRule, each specifying the mapping of an RPC method to one or moreHTTP REST API methods.

func (Http)MarshalJSON

func (sHttp) MarshalJSON() ([]byte,error)

typeHttpRule

type HttpRule struct {// AdditionalBindings: Additional HTTP bindings for the selector. Nested// bindings must not contain an `additional_bindings` field themselves (that// is, the nesting may only be one level deep).AdditionalBindings []*HttpRule `json:"additionalBindings,omitempty"`// Body: The name of the request field whose value is mapped to the HTTP// request body, or `*` for mapping all request fields not captured by the path// pattern to the HTTP body, or omitted for not having any HTTP request body.// NOTE: the referred field must be present at the top-level of the request// message type.Bodystring `json:"body,omitempty"`// Custom: The custom pattern is used for specifying an HTTP method that is not// included in the `pattern` field, such as HEAD, or "*" to leave the HTTP// method unspecified for this rule. The wild-card rule is useful for services// that provide content to Web (HTML) clients.Custom *CustomHttpPattern `json:"custom,omitempty"`// Delete: Maps to HTTP DELETE. Used for deleting a resource.Deletestring `json:"delete,omitempty"`// Get: Maps to HTTP GET. Used for listing and getting information about// resources.Getstring `json:"get,omitempty"`// Patch: Maps to HTTP PATCH. Used for updating a resource.Patchstring `json:"patch,omitempty"`// Post: Maps to HTTP POST. Used for creating a resource or performing an// action.Poststring `json:"post,omitempty"`// Put: Maps to HTTP PUT. Used for replacing a resource.Putstring `json:"put,omitempty"`// ResponseBody: Optional. The name of the response field whose value is mapped// to the HTTP response body. When omitted, the entire response message will be// used as the HTTP response body. NOTE: The referred field must be present at// the top-level of the response message type.ResponseBodystring `json:"responseBody,omitempty"`// Selector: Selects a method to which this rule applies. Refer to selector for// syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "AdditionalBindings") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdditionalBindings") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HttpRule: gRPC Transcoding gRPC Transcoding is a feature for mapping betweena gRPC method and one or more HTTP REST endpoints. It allows developers tobuild a single API service that supports both gRPC APIs and REST APIs. Manysystems, including Google APIs (https://github.com/googleapis/googleapis),Cloud Endpoints (https://cloud.google.com/endpoints), gRPC Gateway(https://github.com/grpc-ecosystem/grpc-gateway), and Envoy(https://github.com/envoyproxy/envoy) proxy support this feature and use itfor large scale production services. `HttpRule` defines the schema of thegRPC/REST mapping. The mapping specifies how different portions of the gRPCrequest message are mapped to the URL path, URL query parameters, and HTTPrequest body. It also controls how the gRPC response message is mapped tothe HTTP response body. `HttpRule` is typically specified as an`google.api.http` annotation on the gRPC method. Each mapping specifies aURL path template and an HTTP method. The path template may refer to one ormore fields in the gRPC request message, as long as each field is anon-repeated field with a primitive (non-message) type. The path templatecontrols how fields of the request message are mapped to the URL path.Example: service Messaging { rpc GetMessage(GetMessageRequest) returns(Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } }message GetMessageRequest { string name = 1; // Mapped to URL path. }message Message { string text = 1; // The resource content. } This enablesan HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` -gRPC: `GetMessage(name: "messages/123456")` Any fields in the requestmessage which are not bound by the path template automatically become HTTPquery parameters if there is no HTTP request body. For example: serviceMessaging { rpc GetMessage(GetMessageRequest) returns (Message) { option(google.api.http) = { get:"/v1/messages/{message_id}" }; } } messageGetMessageRequest { message SubMessage { string subfield = 1; } stringmessage_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URLquery parameter `revision`. SubMessage sub = 3; // Mapped to URL queryparameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping asbelow: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC:`GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:"foo"))` Note that fields which are mapped to URL query parameters must havea primitive type or a repeated primitive type or a non-repeated messagetype. In the case of a repeated type, the parameter can be repeated in theURL as `...?param=A&param=B`. In the case of a message type, each field ofthe message is mapped to a separate parameter, such as`...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body,the `body` field specifies the mapping. Consider a REST update method on themessage resource collection: service Messaging { rpcUpdateMessage(UpdateMessageRequest) returns (Message) { option(google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" };} } message UpdateMessageRequest { string message_id = 1; // mapped to theURL Message message = 2; // mapped to the body } The following HTTP JSON toRPC mapping is enabled, where the representation of the JSON in the requestbody is determined by protos JSON encoding: - HTTP: `PATCH/v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id:"123456" message { text: "Hi!" })` The special name `*` can be used in thebody mapping to define that every field not bound by the path templateshould be mapped to the request body. This enables the following alternativedefinition of the update method: service Messaging { rpcUpdateMessage(Message) returns (Message) { option (google.api.http) = {patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { stringmessage_id = 1; string text = 2; } The following HTTP JSON to RPC mapping isenabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC:`UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*`in the body mapping, it is not possible to have HTTP parameters, as allfields not bound by the path end in the body. This makes this option morerarely used in practice when defining REST APIs. The common usage of `*` isin custom methods which don't use the URL at all for transferring data. Itis possible to define multiple HTTP methods for one RPC by using the`additional_bindings` option. Example: service Messaging { rpcGetMessage(GetMessageRequest) returns (Message) { option (google.api.http) ={ get: "/v1/messages/{message_id}" additional_bindings { get:"/v1/users/{user_id}/messages/{message_id}" } }; } } messageGetMessageRequest { string message_id = 1; string user_id = 2; } Thisenables the following two alternative HTTP JSON to RPC mappings: - HTTP:`GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP:`GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me"message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields(recursive expansion nested messages in the request message) are classifiedinto three categories: - Fields referred by the path template. They arepassed via the URL path. - Fields referred by the HttpRule.body. They arepassed via the HTTP request body. - All other fields are passed via the URLquery parameters, and the parameter name is the field path in the requestmessage. A repeated field can be represented as multiple query parametersunder the same name. 2. If HttpRule.body is "*", there is no URL queryparameter, all fields are passed via URL path and HTTP request body. 3. IfHttpRule.body is omitted, there is no HTTP request body, all fields arepassed via URL path and URL query parameters. Path template syntax Template= "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*"| "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}"; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*`matches a single URL path segment. The syntax `**` matches zero or more URLpath segments, which must be the last part of the URL path except the`Verb`. The syntax `Variable` matches part of the URL path as specified byits template. A variable template must not contain other variables. If avariable matches a single path segment, its template may be omitted, e.g.`{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literaltext in the URL path. If the `LITERAL` contains any reserved character, suchcharacters should be percent-encoded before the matching. If a variablecontains exactly one path segment, such as "{var}" or "{var=*}", whensuch a variable is expanded into a URL path on the client side, allcharacters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server sidedoes the reverse decoding. Such variables show up in the Discovery Document(https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If avariable contains multiple path segments, such as "{var=foo/*}" or"{var=**}", when such a variable is expanded into a URL path on the clientside, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Theserver side does the reverse decoding, except "%2F" and "%2f" are leftunchanged. Such variables show up in the Discovery Document(https://developers.google.com/discovery/v1/reference/apis) as `{+var}`.Using gRPC API Service Configuration gRPC API Service Configuration (serviceconfig) is a configuration language for configuring a gRPC service to becomea user-facing product. The service config is simply the YAML representationof the `google.api.Service` proto message. As an alternative to annotatingyour proto file, you can configure gRPC transcoding in your service configYAML files. You do this by specifying a `HttpRule` that maps the gRPC methodto a REST endpoint, achieving the same effect as the proto annotation. Thiscan be particularly useful if you have a proto that is reused in multipleservices. Note that any transcoding specified in the service config willoverride any matching transcoding configuration in the proto. The followingexample selects a gRPC method and applies an `HttpRule` to it: http: rules:- selector: example.v1.Messaging.GetMessage get:/v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcodingis used to map a gRPC to JSON REST endpoints, the proto to JSON conversionmust follow the proto3 specification(https://developers.google.com/protocol-buffers/docs/proto3#json). While thesingle segment variable follows the semantics ofRFC 6570(https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion,the multi segment variable **does not** followRFC 6570 Section 3.2.3Reserved Expansion. The reason is that the Reserved Expansion does notexpand special characters like `?` and `#`, which would lead to invalidURLs. As the result, gRPC Transcoding uses a custom encoding for multisegment variables. The path variables **must not** refer to any repeated ormapped field, because client libraries are not capable of handling suchvariable expansion. The path variables **must not** capture the leading "/"character. The reason is that the most common use case "{var}" does notcapture the leading "/" character. For consistency, all path variables mustshare the same behavior. Repeated message fields must not be mapped to URLquery parameters, because no client library can support such complicatedmapping. If an API needs to use a JSON array for request or response body,it can map the request or response body to a repeated field. However, somegRPC Transcoding implementations may not support this feature.

func (HttpRule)MarshalJSON

func (sHttpRule) MarshalJSON() ([]byte,error)

typeImpactadded inv0.193.0

type Impact struct {// Detail: Output only. User friendly impact detail in a free form message.Detailstring `json:"detail,omitempty"`// ImpactType: Output only. The type of impact.//// Possible values://   "IMPACT_TYPE_UNSPECIFIED" - Reserved Blocks (Block n contains codes from// 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of// ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of// ANALYSIS_TYPE_RESOURCE_USAGE Block 3 - Impact Type of// ANALYSIS_TYPE_RESOURCE_EXISTENCE ...//   "DEPENDENCY_MISSING_DEPENDENCIES" - Block 1 - Impact Type of// ANALYSIS_TYPE_DEPENDENCY//   "RESOURCE_EXISTENCE_PROJECT" - Block 3 - Impact Type of// ANALYSIS_TYPE_RESOURCE_EXISTENCEImpactTypestring `json:"impactType,omitempty"`// Parent: The parent resource that the analysis is based on and the service// name that the analysis is for. Example:// `projects/100/services/compute.googleapis.com`,// folders/101/services/compute.googleapis.com` and// `organizations/102/services/compute.googleapis.com`. Usually, the parent// resource here is same as the parent resource of the analyzed policy.// However, for some analysis types, the parent can be different. For example,// for resource existence analysis, if the parent resource of the analyzed// policy is a folder or an organization, the parent resource here can still be// the project that contains the resources.Parentstring `json:"parent,omitempty"`// ForceSendFields is a list of field names (e.g. "Detail") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Detail") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Impact: A message to group impacts of updating a policy.

func (Impact)MarshalJSONadded inv0.193.0

func (sImpact) MarshalJSON() ([]byte,error)

typeImportAdminOverridesMetadataadded inv0.45.0

type ImportAdminOverridesMetadata struct {}

ImportAdminOverridesMetadata: Metadata message that provides informationsuch as progress, partial failures, and similar information on eachGetOperation call of LRO returned by ImportAdminOverrides.

typeImportAdminOverridesRequestadded inv0.35.0

type ImportAdminOverridesRequest struct {// Force: Whether to force the creation of the quota overrides. Setting the// force parameter to 'true' ignores all quota safety checks that would fail// the request. QuotaSafetyCheck lists all such validations. If force is set to// true, it is recommended to include a case id in "X-Goog-Request-Reason"// header when sending the request.Forcebool `json:"force,omitempty"`// ForceOnly: The list of quota safety checks to ignore before the override// mutation. Unlike 'force' field that ignores all the quota safety checks, the// 'force_only' field ignores only the specified checks; other checks are still// enforced. The 'force' and 'force_only' fields cannot both be set. If// force_only is specified, it is recommended to include a case id in// "X-Goog-Request-Reason" header when sending the request.//// Possible values://   "QUOTA_SAFETY_CHECK_UNSPECIFIED" - Unspecified quota safety check.//   "LIMIT_DECREASE_BELOW_USAGE" - Validates that a quota mutation would not// cause the consumer's effective limit to be lower than the consumer's quota// usage.//   "LIMIT_DECREASE_PERCENTAGE_TOO_HIGH" - Validates that a quota mutation// would not cause the consumer's effective limit to decrease by more than 10// percent.ForceOnly []string `json:"forceOnly,omitempty"`// InlineSource: The import data is specified in the request message itselfInlineSource *OverrideInlineSource `json:"inlineSource,omitempty"`// ForceSendFields is a list of field names (e.g. "Force") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Force") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ImportAdminOverridesRequest: Request message for ImportAdminOverrides

func (ImportAdminOverridesRequest)MarshalJSONadded inv0.35.0

func (sImportAdminOverridesRequest) MarshalJSON() ([]byte,error)

typeImportAdminOverridesResponseadded inv0.22.0

type ImportAdminOverridesResponse struct {// Overrides: The overrides that were created from the imported data.Overrides []*QuotaOverride `json:"overrides,omitempty"`// ForceSendFields is a list of field names (e.g. "Overrides") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Overrides") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ImportAdminOverridesResponse: Response message for ImportAdminOverrides

func (ImportAdminOverridesResponse)MarshalJSONadded inv0.22.0

func (sImportAdminOverridesResponse) MarshalJSON() ([]byte,error)

typeImportAdminQuotaPoliciesMetadataadded inv0.45.0

type ImportAdminQuotaPoliciesMetadata struct {}

ImportAdminQuotaPoliciesMetadata: Metadata message that provides informationsuch as progress, partial failures, and similar information on eachGetOperation call of LRO returned by ImportAdminQuotaPolicies.

typeImportAdminQuotaPoliciesResponseadded inv0.27.0

type ImportAdminQuotaPoliciesResponse struct {// Policies: The policies that were created from the imported data.Policies []*AdminQuotaPolicy `json:"policies,omitempty"`// ForceSendFields is a list of field names (e.g. "Policies") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Policies") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ImportAdminQuotaPoliciesResponse: Response message forImportAdminQuotaPolicies

func (ImportAdminQuotaPoliciesResponse)MarshalJSONadded inv0.27.0

func (sImportAdminQuotaPoliciesResponse) MarshalJSON() ([]byte,error)

typeImportConsumerOverridesMetadataadded inv0.45.0

type ImportConsumerOverridesMetadata struct {}

ImportConsumerOverridesMetadata: Metadata message that provides informationsuch as progress, partial failures, and similar information on eachGetOperation call of LRO returned by ImportConsumerOverrides.

typeImportConsumerOverridesRequestadded inv0.28.0

type ImportConsumerOverridesRequest struct {// Force: Whether to force the creation of the quota overrides. Setting the// force parameter to 'true' ignores all quota safety checks that would fail// the request. QuotaSafetyCheck lists all such validations. If force is set to// true, it is recommended to include a case id in "X-Goog-Request-Reason"// header when sending the request.Forcebool `json:"force,omitempty"`// ForceOnly: The list of quota safety checks to ignore before the override// mutation. Unlike 'force' field that ignores all the quota safety checks, the// 'force_only' field ignores only the specified checks; other checks are still// enforced. The 'force' and 'force_only' fields cannot both be set. If// force_only is specified, it is recommended to include a case id in// "X-Goog-Request-Reason" header when sending the request.//// Possible values://   "QUOTA_SAFETY_CHECK_UNSPECIFIED" - Unspecified quota safety check.//   "LIMIT_DECREASE_BELOW_USAGE" - Validates that a quota mutation would not// cause the consumer's effective limit to be lower than the consumer's quota// usage.//   "LIMIT_DECREASE_PERCENTAGE_TOO_HIGH" - Validates that a quota mutation// would not cause the consumer's effective limit to decrease by more than 10// percent.ForceOnly []string `json:"forceOnly,omitempty"`// InlineSource: The import data is specified in the request message itselfInlineSource *OverrideInlineSource `json:"inlineSource,omitempty"`// ForceSendFields is a list of field names (e.g. "Force") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Force") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ImportConsumerOverridesRequest: Request message for ImportConsumerOverrides

func (ImportConsumerOverridesRequest)MarshalJSONadded inv0.28.0

func (sImportConsumerOverridesRequest) MarshalJSON() ([]byte,error)

typeImportConsumerOverridesResponseadded inv0.22.0

type ImportConsumerOverridesResponse struct {// Overrides: The overrides that were created from the imported data.Overrides []*QuotaOverride `json:"overrides,omitempty"`// ForceSendFields is a list of field names (e.g. "Overrides") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Overrides") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ImportConsumerOverridesResponse: Response message forImportConsumerOverrides

func (ImportConsumerOverridesResponse)MarshalJSONadded inv0.22.0

func (sImportConsumerOverridesResponse) MarshalJSON() ([]byte,error)

typeJavaSettingsadded inv0.104.0

type JavaSettings struct {// Common: Some settings.Common *CommonLanguageSettings `json:"common,omitempty"`// 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: library_settings:// java_settings: library_package: com.google.cloud.pubsub.v1LibraryPackagestring `json:"libraryPackage,omitempty"`// 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: SubscriptionAdminServiceClassNames map[string]string `json:"serviceClassNames,omitempty"`// ForceSendFields is a list of field names (e.g. "Common") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Common") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

JavaSettings: Settings for Java client libraries.

func (JavaSettings)MarshalJSONadded inv0.104.0

func (sJavaSettings) MarshalJSON() ([]byte,error)

typeJwtLocationadded inv0.20.0

type JwtLocation struct {// Cookie: Specifies cookie name to extract JWT token.Cookiestring `json:"cookie,omitempty"`// Header: Specifies HTTP header name to extract JWT token.Headerstring `json:"header,omitempty"`// Query: Specifies URL query parameter name to extract JWT token.Querystring `json:"query,omitempty"`// ValuePrefix: The value prefix. The value format is "value_prefix{token}"// Only applies to "in" header type. Must be empty for "in" query type. If not// empty, the header value has to match (case sensitive) this prefix. If not// matched, JWT will not be extracted. If matched, JWT will be extracted after// the prefix is removed. For example, for "Authorization: Bearer {JWT}",// value_prefix="Bearer " with a space at the end.ValuePrefixstring `json:"valuePrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "Cookie") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cookie") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

JwtLocation: Specifies a location to extract JWT from an API request.

func (JwtLocation)MarshalJSONadded inv0.20.0

func (sJwtLocation) MarshalJSON() ([]byte,error)

typeLabelDescriptor

type LabelDescriptor struct {// Description: A human-readable description for the label.Descriptionstring `json:"description,omitempty"`// Key: The label key.Keystring `json:"key,omitempty"`// ValueType: The type of data that can be assigned to the label.//// Possible values://   "STRING" - A variable-length string. This is the default.//   "BOOL" - Boolean; true or false.//   "INT64" - A 64-bit signed integer.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LabelDescriptor: A description of a label.

func (LabelDescriptor)MarshalJSON

func (sLabelDescriptor) MarshalJSON() ([]byte,error)

typeListAdminOverridesResponseadded inv0.21.0

type ListAdminOverridesResponse struct {// NextPageToken: Token identifying which result to start with; returned by a// previous list call.NextPageTokenstring `json:"nextPageToken,omitempty"`// Overrides: Admin overrides on this limit.Overrides []*QuotaOverride `json:"overrides,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListAdminOverridesResponse: Response message for ListAdminOverrides.

func (ListAdminOverridesResponse)MarshalJSONadded inv0.21.0

func (sListAdminOverridesResponse) MarshalJSON() ([]byte,error)

typeListConsumerOverridesResponseadded inv0.21.0

type ListConsumerOverridesResponse struct {// NextPageToken: Token identifying which result to start with; returned by a// previous list call.NextPageTokenstring `json:"nextPageToken,omitempty"`// Overrides: Consumer overrides on this limit.Overrides []*QuotaOverride `json:"overrides,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListConsumerOverridesResponse: Response message for ListConsumerOverrides.

func (ListConsumerOverridesResponse)MarshalJSONadded inv0.21.0

func (sListConsumerOverridesResponse) MarshalJSON() ([]byte,error)

typeListConsumerQuotaMetricsResponseadded inv0.21.0

type ListConsumerQuotaMetricsResponse struct {// Metrics: Quota settings for the consumer, organized by quota metric.Metrics []*ConsumerQuotaMetric `json:"metrics,omitempty"`// NextPageToken: Token identifying which result to start with; returned by a// previous list call.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Metrics") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Metrics") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListConsumerQuotaMetricsResponse: Response message forListConsumerQuotaMetrics

func (ListConsumerQuotaMetricsResponse)MarshalJSONadded inv0.21.0

func (sListConsumerQuotaMetricsResponse) MarshalJSON() ([]byte,error)

typeListOperationsResponse

type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*Operation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections e.g. when attempting to list all resources across all supported// locations.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse)MarshalJSON

func (sListOperationsResponse) MarshalJSON() ([]byte,error)

typeListServicesResponse

type ListServicesResponse struct {// NextPageToken: Token that can be passed to `ListServices` to resume a// paginated query.NextPageTokenstring `json:"nextPageToken,omitempty"`// Services: The available services for the requested project.Services []*Service `json:"services,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListServicesResponse: Response message for the `ListServices` method.

func (ListServicesResponse)MarshalJSON

func (sListServicesResponse) MarshalJSON() ([]byte,error)

typeLogDescriptor

type LogDescriptor struct {// Description: A human-readable description of this log. This information// appears in the documentation and can contain details.Descriptionstring `json:"description,omitempty"`// DisplayName: The human-readable name for this log. This information appears// on the user interface and should be concise.DisplayNamestring `json:"displayName,omitempty"`// Labels: The set of labels that are available to describe a specific log// entry. Runtime requests that contain labels not specified here are// considered invalid.Labels []*LabelDescriptor `json:"labels,omitempty"`// Name: The name of the log. It must be less than 512 characters long and can// include the following characters: upper- and lower-case alphanumeric// characters [A-Za-z0-9], and punctuation characters including slash,// underscore, hyphen, period [/_-.].Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LogDescriptor: A description of a log type. Example in YAML format: - name:library.googleapis.com/activity_history description: The history ofborrowing and returning library items. display_name: Activity labels: - key:/customer_id description: Identifier of a library customer

func (LogDescriptor)MarshalJSON

func (sLogDescriptor) MarshalJSON() ([]byte,error)

typeLogging

type Logging struct {// ConsumerDestinations: Logging configurations for sending logs to the// consumer project. There can be multiple consumer destinations, each one must// have a different monitored resource type. A log can be used in at most one// consumer destination.ConsumerDestinations []*LoggingDestination `json:"consumerDestinations,omitempty"`// ProducerDestinations: Logging configurations for sending logs to the// producer project. There can be multiple producer destinations, each one must// have a different monitored resource type. A log can be used in at most one// producer destination.ProducerDestinations []*LoggingDestination `json:"producerDestinations,omitempty"`// ForceSendFields is a list of field names (e.g. "ConsumerDestinations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConsumerDestinations") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Logging: Logging configuration of the service. The following example showshow to configure logs to be sent to the producer and consumer projects. Inthe example, the `activity_history` log is sent to both the producer andconsumer projects, whereas the `purchase_history` log is only sent to theproducer project. monitored_resources: - type: library.googleapis.com/branchlabels: - key: /city description: The city where the library branch islocated in. - key: /name description: The name of the branch. logs: - name:activity_history labels: - key: /customer_id - name: purchase_historylogging: producer_destinations: - monitored_resource:library.googleapis.com/branch logs: - activity_history - purchase_historyconsumer_destinations: - monitored_resource: library.googleapis.com/branchlogs: - activity_history

func (Logging)MarshalJSON

func (sLogging) MarshalJSON() ([]byte,error)

typeLoggingDestination

type LoggingDestination struct {// Logs: Names of the logs to be sent to this destination. Each name must be// defined in the Service.logs section. If the log name is not a domain scoped// name, it will be automatically prefixed with the service name followed by// "/".Logs []string `json:"logs,omitempty"`// MonitoredResource: The monitored resource type. The type must be defined in// the Service.monitored_resources section.MonitoredResourcestring `json:"monitoredResource,omitempty"`// ForceSendFields is a list of field names (e.g. "Logs") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Logs") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LoggingDestination: Configuration of a specific logging destination (theproducer project or the consumer project).

func (LoggingDestination)MarshalJSON

func (sLoggingDestination) MarshalJSON() ([]byte,error)

typeLongRunningadded inv0.104.0

type LongRunning struct {// InitialPollDelay: Initial delay after which the first poll request will be// made. Default value: 5 seconds.InitialPollDelaystring `json:"initialPollDelay,omitempty"`// MaxPollDelay: Maximum time between two subsequent poll requests. Default// value: 45 seconds.MaxPollDelaystring `json:"maxPollDelay,omitempty"`// PollDelayMultiplier: Multiplier to gradually increase delay between// subsequent polls until it reaches max_poll_delay. Default value: 1.5.PollDelayMultiplierfloat64 `json:"pollDelayMultiplier,omitempty"`// TotalPollTimeout: Total polling timeout. Default value: 5 minutes.TotalPollTimeoutstring `json:"totalPollTimeout,omitempty"`// ForceSendFields is a list of field names (e.g. "InitialPollDelay") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InitialPollDelay") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LongRunning: Describes settings to use when generating API methods that usethe long-running operation pattern. All default values below are from thoseused in the client library generators (e.g. Java(https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

func (LongRunning)MarshalJSONadded inv0.104.0

func (sLongRunning) MarshalJSON() ([]byte,error)

func (*LongRunning)UnmarshalJSONadded inv0.104.0

func (s *LongRunning) UnmarshalJSON(data []byte)error

typeMcpEnableRuleadded inv0.250.0

type McpEnableRule struct {// McpServices: List of enabled MCP services.McpServices []*McpService `json:"mcpServices,omitempty"`// ForceSendFields is a list of field names (e.g. "McpServices") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "McpServices") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

McpEnableRule: McpEnableRule contains MCP enablement related rules.

func (McpEnableRule)MarshalJSONadded inv0.250.0

func (sMcpEnableRule) MarshalJSON() ([]byte,error)

typeMcpPolicyadded inv0.250.0

type McpPolicy struct {// CreateTime: Output only. The time the policy was created. For singleton// policies (such as the `default` policy), this is the first touch of the// policy.CreateTimestring `json:"createTime,omitempty"`// Etag: An opaque tag indicating the current version of the policy, used for// concurrency control.Etagstring `json:"etag,omitempty"`// McpEnableRules: McpEnableRules contains MCP enablement related rules.McpEnableRules []*McpEnableRule `json:"mcpEnableRules,omitempty"`// Name: Output only. The resource name of the policy. Only the `default`// policy is supported. We allow the following formats:// `projects/{PROJECT_NUMBER}/mcpPolicies/default`,// `projects/{PROJECT_ID}/mcpPolicies/default`,// `folders/{FOLDER_ID}/mcpPolicies/default`,// `organizations/{ORG_ID}/mcpPolicies/default`.Namestring `json:"name,omitempty"`// UpdateTime: Output only. The time the policy was last updated.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

McpPolicy: MCP Consumer Policy is a set of rules that define MCP relatedpolicy for a cloud resource hierarchy.

func (McpPolicy)MarshalJSONadded inv0.250.0

func (sMcpPolicy) MarshalJSON() ([]byte,error)

typeMcpServiceadded inv0.250.0

type McpService struct {// Service: The names of the services that are enabled for MCP. Example:// `services/library-example.googleapis.com`Servicestring `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "Service") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Service") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

McpService: McpService contains the service names that are enabled for MCP.

func (McpService)MarshalJSONadded inv0.250.0

func (sMcpService) MarshalJSON() ([]byte,error)

typeMethod

type Method struct {// Edition: The source edition string, only valid when syntax is// SYNTAX_EDITIONS. This field should be ignored, instead the edition should be// inherited from Api. This is similar to Field and EnumValue.Editionstring `json:"edition,omitempty"`// Name: The simple name of this method.Namestring `json:"name,omitempty"`// Options: Any metadata attached to the method.Options []*Option `json:"options,omitempty"`// RequestStreaming: If true, the request is streamed.RequestStreamingbool `json:"requestStreaming,omitempty"`// RequestTypeUrl: A URL of the input message type.RequestTypeUrlstring `json:"requestTypeUrl,omitempty"`// ResponseStreaming: If true, the response is streamed.ResponseStreamingbool `json:"responseStreaming,omitempty"`// ResponseTypeUrl: The URL of the output message type.ResponseTypeUrlstring `json:"responseTypeUrl,omitempty"`// Syntax: The source syntax of this method. This field should be ignored,// instead the syntax should be inherited from Api. This is similar to Field// and EnumValue.//// Possible values://   "SYNTAX_PROTO2" - Syntax `proto2`.//   "SYNTAX_PROTO3" - Syntax `proto3`.//   "SYNTAX_EDITIONS" - Syntax `editions`.Syntaxstring `json:"syntax,omitempty"`// ForceSendFields is a list of field names (e.g. "Edition") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Edition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Method: Method represents a method of an API interface. New usages of thismessage as an alternative to MethodDescriptorProto are strongly discouraged.This message does not reliability preserve all information necessary tomodel the schema and preserve semantics. Instead make use ofFileDescriptorSet which preserves the necessary information.

func (Method)MarshalJSON

func (sMethod) MarshalJSON() ([]byte,error)

typeMethodPolicyadded inv0.133.0

type MethodPolicy struct {// RequestPolicies: Policies that are applicable to the request message.RequestPolicies []*FieldPolicy `json:"requestPolicies,omitempty"`// Selector: Selects a method to which these policies should be enforced, for// example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector// for syntax details. NOTE: This field must not be set in the proto// annotation. It will be automatically filled by the service config compiler .Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "RequestPolicies") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RequestPolicies") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MethodPolicy: Defines policies applying to an RPC method.

func (MethodPolicy)MarshalJSONadded inv0.133.0

func (sMethodPolicy) MarshalJSON() ([]byte,error)

typeMethodSettingsadded inv0.104.0

type MethodSettings struct {// 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_idAutoPopulatedFields []string `json:"autoPopulatedFields,omitempty"`// Batching: Batching configuration for an API method in client libraries.// Example of a YAML configuration: publishing: method_settings: - selector:// google.example.v1.ExampleService.BatchCreateExample batching:// element_count_threshold: 1000 request_byte_threshold: 100000000// delay_threshold_millis: 10Batching *BatchingConfigProto `json:"batching,omitempty"`// 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 minutesLongRunning *LongRunning `json:"longRunning,omitempty"`// 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...Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "AutoPopulatedFields") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AutoPopulatedFields") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MethodSettings: Describes the generator configuration for a method.

func (MethodSettings)MarshalJSONadded inv0.104.0

func (sMethodSettings) MarshalJSON() ([]byte,error)

typeMetricDescriptor

type MetricDescriptor struct {// Description: A detailed description of the metric, which can be used in// documentation.Descriptionstring `json:"description,omitempty"`// DisplayName: A concise name for the metric, which can be displayed in user// interfaces. Use sentence case without an ending period, for example "Request// count". This field is optional but it is recommended to be set for any// metrics associated with user-visible concepts, such as Quota.DisplayNamestring `json:"displayName,omitempty"`// Labels: The set of labels that can be used to describe a specific instance// of this metric type. For example, the// `appengine.googleapis.com/http/server/response_latencies` metric type has a// label for the HTTP response code, `response_code`, so you can look at// latencies for successful responses or just for responses that failed.Labels []*LabelDescriptor `json:"labels,omitempty"`// LaunchStage: Optional. The launch stage of the metric definition.//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud// Platform Subject to the Deprecation// Policy](https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// Metadata: Optional. Metadata which can be used to guide usage of the metric.Metadata *MetricDescriptorMetadata `json:"metadata,omitempty"`// MetricKind: Whether the metric records instantaneous values, changes to a// value, etc. Some combinations of `metric_kind` and `value_type` might not be// supported.//// Possible values://   "METRIC_KIND_UNSPECIFIED" - Do not use this default value.//   "GAUGE" - An instantaneous measurement of a value.//   "DELTA" - The change in a value during a time interval.//   "CUMULATIVE" - A value accumulated over a time interval. Cumulative// measurements in a time series should have the same start time and increasing// end times, until an event resets the cumulative value to zero and sets a new// start time for the following points.MetricKindstring `json:"metricKind,omitempty"`// MonitoredResourceTypes: Read-only. If present, then a time series, which is// identified partially by a metric type and a MonitoredResourceDescriptor,// that is associated with this metric type can only be associated with one of// the monitored resource types listed here.MonitoredResourceTypes []string `json:"monitoredResourceTypes,omitempty"`// Name: The resource name of the metric descriptor.Namestring `json:"name,omitempty"`// Type: The metric type, including its DNS name prefix. The type is not// URL-encoded. All user-defined metric types have the DNS name// `custom.googleapis.com` or `external.googleapis.com`. Metric types should// use a natural hierarchical grouping. For example:// "custom.googleapis.com/invoice/paid/amount"// "external.googleapis.com/prometheus/up"// "appengine.googleapis.com/http/server/response_latencies"Typestring `json:"type,omitempty"`// Unit: The units in which the metric value is reported. It is only applicable// if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`// defines the representation of the stored metric values. Different systems// might scale the values to be more easily displayed (so a value of `0.02kBy`// _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be// displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of// the metric is always in thousands of bytes, no matter how it might be// displayed. If you want a custom metric to record the exact number of// CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose// `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses// 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if// you want a custom metric to record data in a more granular way, you can// create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then// write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and// write `11.723` (which is `12005/1024`). The supported units are a subset of// The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html)// standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second *// `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)**// * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) *// `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) *// `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12)// * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto// (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti`// tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these// connectors: * `/` division or ratio (as an infix operator). For examples,// `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in// a metric `unit`; rates should always be computed at query time from the// underlying cumulative or delta value). * `.` multiplication or composition// (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar// for a unit is as follows: Expression = Component { "." Component } { "/"// Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] |// Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just// a comment if it follows a `UNIT`. If the annotation is used alone, then the// unit is equivalent to `1`. For examples, `{request}/s == 1/s`,// `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable// ASCII characters not containing `{` or `}`. * `1` represents a unitary// dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of// 1, such as in `1/s`. It is typically used when none of the basic units are// appropriate. For example, "new users per day" can be represented as `1/d` or// `{new-users}/d` (and a metric value `5` would mean "5 new users).// Alternatively, "thousands of page views per day" would be represented as// `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would// mean "5300 page views per day"). * `%` represents dimensionless value of// 1/100, and annotates values giving a percentage (so the metric values are// typically in the range of 0..100, and a metric value `3` means "3 percent").// * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1,// that will be multiplied by 100 and displayed as a percentage (so a metric// value `0.03` means "3 percent").Unitstring `json:"unit,omitempty"`// ValueType: Whether the measurement is an integer, a floating-point number,// etc. Some combinations of `metric_kind` and `value_type` might not be// supported.//// Possible values://   "VALUE_TYPE_UNSPECIFIED" - Do not use this default value.//   "BOOL" - The value is a boolean. This value type can be used only if the// metric kind is `GAUGE`.//   "INT64" - The value is a signed 64-bit integer.//   "DOUBLE" - The value is a double precision floating point number.//   "STRING" - The value is a text string. This value type can be used only if// the metric kind is `GAUGE`.//   "DISTRIBUTION" - The value is a `Distribution`.//   "MONEY" - The value is money.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricDescriptor: Defines a metric type and its schema. Once a metricdescriptor is created, deleting or altering it stops data collection andmakes the metric type's existing data unusable.

func (MetricDescriptor)MarshalJSON

func (sMetricDescriptor) MarshalJSON() ([]byte,error)

typeMetricDescriptorMetadata

type MetricDescriptorMetadata struct {// IngestDelay: The delay of data points caused by ingestion. Data points older// than this age are guaranteed to be ingested and available to be read,// excluding data loss due to errors.IngestDelaystring `json:"ingestDelay,omitempty"`// LaunchStage: Deprecated. Must use the MetricDescriptor.launch_stage instead.//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud// Platform Subject to the Deprecation// Policy](https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// SamplePeriod: The sampling period of metric data points. For metrics which// are written periodically, consecutive data points are stored at this time// interval, excluding data loss due to errors. Metrics with a higher// granularity have a smaller sampling period.SamplePeriodstring `json:"samplePeriod,omitempty"`// TimeSeriesResourceHierarchyLevel: The scope of the timeseries data of the// metric.//// Possible values://   "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED" - Do not use this// default value.//   "PROJECT" - Scopes a metric to a project.//   "ORGANIZATION" - Scopes a metric to an organization.//   "FOLDER" - Scopes a metric to a folder.TimeSeriesResourceHierarchyLevel []string `json:"timeSeriesResourceHierarchyLevel,omitempty"`// ForceSendFields is a list of field names (e.g. "IngestDelay") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IngestDelay") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricDescriptorMetadata: Additional annotations that can be used to guidethe usage of a metric.

func (MetricDescriptorMetadata)MarshalJSON

func (sMetricDescriptorMetadata) MarshalJSON() ([]byte,error)

typeMetricRule

type MetricRule struct {// MetricCosts: Metrics to update when the selected methods are called, and the// associated cost applied to each metric. The key of the map is the metric// name, and the values are the amount increased for the metric against which// the quota limits are defined. The value must not be negative.MetricCosts map[string]string `json:"metricCosts,omitempty"`// Selector: Selects the methods to which this rule applies. Refer to selector// for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "MetricCosts") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MetricCosts") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricRule: Bind API methods to metrics. Binding a method to a metric causesthat metric's configured quota behaviors to apply to the method call.

func (MetricRule)MarshalJSON

func (sMetricRule) MarshalJSON() ([]byte,error)

typeMixin

type Mixin struct {// Name: The fully qualified name of the interface which is included.Namestring `json:"name,omitempty"`// Root: If non-empty specifies a path under which inherited HTTP paths are// rooted.Rootstring `json:"root,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Mixin: Declares an API Interface to be included in this interface. Theincluding interface must redeclare all the methods from the includedinterface, but documentation and options are inherited as follows: - Ifafter comment and whitespace stripping, the documentation string of theredeclared method is empty, it will be inherited from the original method. -Each annotation belonging to the service config (http, visibility) which isnot set in the redeclared method will be inherited. - If an http annotationis inherited, the path pattern will be modified as follows. Any versionprefix will be replaced by the version of the including interface plus theroot path if specified. Example of a simple mixin: package google.acl.v1;service AccessControl { // Get the underlying ACL object. rpcGetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get ="/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage {// rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpcGetData(GetDataRequest) returns (Data) { option (google.api.http).get ="/v2/{resource=**}"; } } Example of a mixin configuration: apis: - name:google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl Themixin construct implies that all methods in `AccessControl` are alsodeclared with same name and request/response types in `Storage`. Adocumentation generator or annotation processor will see the effective`Storage.GetAcl` method after inheriting documentation and annotations asfollows: service Storage { // Get the underlying ACL object. rpcGetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get ="/v2/{resource=**}:getAcl"; } ... } Note how the version in the path patternchanged from `v1` to `v2`. If the `root` field in the mixin is specified, itshould be a relative path under which inherited HTTP paths are placed.Example: apis: - name: google.storage.v2.Storage mixins: - name:google.acl.v1.AccessControl root: acls This implies the following inheritedHTTP annotation: service Storage { // Get the underlying ACL object. rpcGetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get ="/v2/acls/{resource=**}:getAcl"; } ... }

func (Mixin)MarshalJSON

func (sMixin) MarshalJSON() ([]byte,error)

typeMonitoredResourceDescriptor

type MonitoredResourceDescriptor struct {// Description: Optional. A detailed description of the monitored resource type// that might be used in documentation.Descriptionstring `json:"description,omitempty"`// DisplayName: Optional. A concise name for the monitored resource type that// might be displayed in user interfaces. It should be a Title Cased Noun// Phrase, without any article or other determiners. For example, "Google// Cloud SQL Database".DisplayNamestring `json:"displayName,omitempty"`// Labels: Required. A set of labels used to describe instances of this// monitored resource type. For example, an individual Google Cloud SQL// database is identified by values for the labels "database_id" and// "zone".Labels []*LabelDescriptor `json:"labels,omitempty"`// LaunchStage: Optional. The launch stage of the monitored resource// definition.//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud// Platform Subject to the Deprecation// Policy](https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// Name: Optional. The resource name of the monitored resource descriptor:// "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type}// is the value of the `type` field in this object and {project_id} is a// project ID that provides API-specific context for accessing the type. APIs// that do not use project information can use the resource name format// "monitoredResourceDescriptors/{type}".Namestring `json:"name,omitempty"`// Type: Required. The monitored resource type. For example, the type// "cloudsql_database" represents databases in Google Cloud SQL. For a list// of types, see Monitored resource types// (https://cloud.google.com/monitoring/api/resources) and Logging resource// types (https://cloud.google.com/logging/docs/api/v2/resource-list).Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MonitoredResourceDescriptor: An object that describes the schema of aMonitoredResource object using a type name and a set of labels. For example,the monitored resource descriptor for Google Compute Engine VM instances hasa type of "gce_instance" and specifies the use of the labels"instance_id" and "zone" to identify particular VM instances. DifferentAPIs can support different monitored resource types. APIs generally providea `list` method that returns the monitored resource descriptors used by theAPI.

func (MonitoredResourceDescriptor)MarshalJSON

func (sMonitoredResourceDescriptor) MarshalJSON() ([]byte,error)

typeMonitoring

type Monitoring struct {// ConsumerDestinations: Monitoring configurations for sending metrics to the// consumer project. There can be multiple consumer destinations. A monitored// resource type may appear in multiple monitoring destinations if different// aggregations are needed for different sets of metrics associated with that// monitored resource type. A monitored resource and metric pair may only be// used once in the Monitoring configuration.ConsumerDestinations []*MonitoringDestination `json:"consumerDestinations,omitempty"`// ProducerDestinations: Monitoring configurations for sending metrics to the// producer project. There can be multiple producer destinations. A monitored// resource type may appear in multiple monitoring destinations if different// aggregations are needed for different sets of metrics associated with that// monitored resource type. A monitored resource and metric pair may only be// used once in the Monitoring configuration.ProducerDestinations []*MonitoringDestination `json:"producerDestinations,omitempty"`// ForceSendFields is a list of field names (e.g. "ConsumerDestinations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConsumerDestinations") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Monitoring: Monitoring configuration of the service. The example below showshow to configure monitored resources and metrics for monitoring. In theexample, a monitored resource and two metrics are defined. The`library.googleapis.com/book/returned_count` metric is sent to both producerand consumer projects, whereas the `library.googleapis.com/book/num_overdue`metric is only sent to the consumer project. monitored_resources: - type:library.googleapis.com/Branch display_name: "Library Branch" description: "Abranch of a library." launch_stage: GA labels: - key: resource_containerdescription: "The Cloud container (ie. project id) for the Branch." - key:location description: "The location of the library branch." - key: branch_iddescription: "The id of the branch." metrics: - name:library.googleapis.com/book/returned_count display_name: "Books Returned"description: "The count of books that have been returned." launch_stage: GAmetric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_iddescription: "The id of the customer." - name:library.googleapis.com/book/num_overdue display_name: "Books Overdue"description: "The current number of overdue books." launch_stage: GAmetric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_iddescription: "The id of the customer." monitoring: producer_destinations: -monitored_resource: library.googleapis.com/Branch metrics: -library.googleapis.com/book/returned_count consumer_destinations: -monitored_resource: library.googleapis.com/Branch metrics: -library.googleapis.com/book/returned_count -library.googleapis.com/book/num_overdue

func (Monitoring)MarshalJSON

func (sMonitoring) MarshalJSON() ([]byte,error)

typeMonitoringDestination

type MonitoringDestination struct {// Metrics: Types of the metrics to report to this monitoring destination. Each// type must be defined in Service.metrics section.Metrics []string `json:"metrics,omitempty"`// MonitoredResource: The monitored resource type. The type must be defined in// Service.monitored_resources section.MonitoredResourcestring `json:"monitoredResource,omitempty"`// ForceSendFields is a list of field names (e.g. "Metrics") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Metrics") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MonitoringDestination: Configuration of a specific monitoring destination(the producer project or the consumer project).

func (MonitoringDestination)MarshalJSON

func (sMonitoringDestination) MarshalJSON() ([]byte,error)

typeNodeSettingsadded inv0.104.0

type NodeSettings struct {// Common: Some settings.Common *CommonLanguageSettings `json:"common,omitempty"`// ForceSendFields is a list of field names (e.g. "Common") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Common") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NodeSettings: Settings for Node client libraries.

func (NodeSettings)MarshalJSONadded inv0.104.0

func (sNodeSettings) MarshalJSON() ([]byte,error)

typeOAuthRequirements

type OAuthRequirements struct {// CanonicalScopes: The list of publicly documented OAuth scopes that are// allowed access. An OAuth token containing any of these scopes will be// accepted. Example: canonical_scopes://https://www.googleapis.com/auth/calendar,//https://www.googleapis.com/auth/calendar.readCanonicalScopesstring `json:"canonicalScopes,omitempty"`// ForceSendFields is a list of field names (e.g. "CanonicalScopes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CanonicalScopes") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

OAuthRequirements: OAuth scopes are a way to define data and permissions ondata. For example, there are scopes defined for "Read-only access to GoogleCalendar" and "Access to Cloud Platform". Users can consent to a scope foran application, giving it permission to access that data on their behalf.OAuth scope specifications should be fairly coarse grained; a user will needto see and understand the text description of what your scope means. In mostcases: use one or at most two OAuth scopes for an entire family of products.If your product has multiple APIs, you should probably be sharing the OAuthscope across all of those APIs. When you need finer grained OAuth consentscreens: talk with your product management about how developers will usethem in practice. Please note that even though each of the canonical scopesis enough for a request to be accepted and passed to the backend, a requestcan still fail due to the backend requiring additional scopes orpermissions.

func (OAuthRequirements)MarshalJSON

func (sOAuthRequirements) MarshalJSON() ([]byte,error)

typeOperation

type Operation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *Status `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Operation: This resource represents a long-running operation that is theresult of a network API call.

func (Operation)MarshalJSON

func (sOperation) MarshalJSON() ([]byte,error)

typeOperationMetadata

type OperationMetadata struct {// ResourceNames: The full name of the resources that this operation is// directly associated with.ResourceNames []string `json:"resourceNames,omitempty"`// ForceSendFields is a list of field names (e.g. "ResourceNames") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResourceNames") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

OperationMetadata: The operation metadata returned for the batchend servicesoperation.

func (OperationMetadata)MarshalJSON

func (sOperationMetadata) MarshalJSON() ([]byte,error)

typeOperationsGetCall

type OperationsGetCall struct {// contains filtered or unexported fields}

func (*OperationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*OperationsGetCall)Do

Do executes the "serviceusage.operations.get" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OperationsGetCall)Header

func (c *OperationsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*OperationsGetCall)IfNoneMatch

func (c *OperationsGetCall) IfNoneMatch(entityTagstring) *OperationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeOperationsListCall

type OperationsListCall struct {// contains filtered or unexported fields}

func (*OperationsListCall)Context

Context sets the context to be used in this call's Do method.

func (*OperationsListCall)Do

Do executes the "serviceusage.operations.list" call.Any non-2xx status code is an error. Response headers are in either*ListOperationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*OperationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OperationsListCall)Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*OperationsListCall)Header

func (c *OperationsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*OperationsListCall)IfNoneMatch

func (c *OperationsListCall) IfNoneMatch(entityTagstring) *OperationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*OperationsListCall)Name

Name sets the optional parameter "name": The name of the operation's parentresource.

func (*OperationsListCall)PageSize

func (c *OperationsListCall) PageSize(pageSizeint64) *OperationsListCall

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*OperationsListCall)PageToken

func (c *OperationsListCall) PageToken(pageTokenstring) *OperationsListCall

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*OperationsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*OperationsListCall)ReturnPartialSuccessadded inv0.255.0

func (c *OperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *OperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in the[ListOperationsResponse.unreachable] field. This can only be `true` whenreading across collections e.g. when `parent` is set to"projects/example/locations/-". This field is not by default supported andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeOperationsService

type OperationsService struct {// contains filtered or unexported fields}

funcNewOperationsService

func NewOperationsService(s *APIService) *OperationsService

func (*OperationsService)Get

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*OperationsService)List

List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.

typeOption

type Option struct {// Name: The option's name. For protobuf built-in options (options defined in// descriptor.proto), this is the short name. For example, "map_entry". For// custom options, it should be the fully-qualified name. For example,// "google.api.http".Namestring `json:"name,omitempty"`// Value: The option's value packed in an Any message. If the value is a// primitive, the corresponding wrapper type defined in// google/protobuf/wrappers.proto should be used. If the value is an enum, it// should be stored as an int32 value using the google.protobuf.Int32Value// type.Valuegoogleapi.RawMessage `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Option: A protocol buffer option, which can be attached to a message, field,enumeration, etc. New usages of this message as an alternative toFileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions,ServiceOptions, or MethodOptions are strongly discouraged.

func (Option)MarshalJSON

func (sOption) MarshalJSON() ([]byte,error)

typeOverrideInlineSourceadded inv0.28.0

type OverrideInlineSource struct {// Overrides: The overrides to create. Each override must have a value for// 'metric' and 'unit', to specify which metric and which limit the override// should be applied to. The 'name' field of the override does not need to be// set; it is ignored.Overrides []*QuotaOverride `json:"overrides,omitempty"`// ForceSendFields is a list of field names (e.g. "Overrides") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Overrides") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

OverrideInlineSource: Import data embedded in the request message

func (OverrideInlineSource)MarshalJSONadded inv0.28.0

func (sOverrideInlineSource) MarshalJSON() ([]byte,error)

typePage

type Page struct {// Content: The Markdown content of the page. You can use “`(== include {path}// ==)“` to include content from a Markdown file. The content can be used to// produce the documentation page such as HTML format page.Contentstring `json:"content,omitempty"`// Name: The name of the page. It will be used as an identity of the page to// generate URI of the page, text of the link to this page in navigation, etc.// The full page name (start from the root page name to this page concatenated// with `.`) can be used as reference to the page in your documentation. For// example: pages: - name: Tutorial content: (== include tutorial.md ==)// subpages: - name: Java content: (== include tutorial_java.md ==) You can// reference `Java` page using Markdown reference link syntax: `Java`.Namestring `json:"name,omitempty"`// Subpages: Subpages of this page. The order of subpages specified here will// be honored in the generated docset.Subpages []*Page `json:"subpages,omitempty"`// ForceSendFields is a list of field names (e.g. "Content") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Content") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Page: Represents a documentation page. A page can contain subpages torepresent nested documentation set structure.

func (Page)MarshalJSON

func (sPage) MarshalJSON() ([]byte,error)

typePhpSettingsadded inv0.104.0

type PhpSettings struct {// Common: Some settings.Common *CommonLanguageSettings `json:"common,omitempty"`// LibraryPackage: The package name to use in Php. Clobbers the php_namespace// option set in the protobuf. This should be used **only** by APIs who have// already set the language_settings.php.package_name" field in gapic.yaml. API// teams should use the protobuf php_namespace option where possible. Example// of a YAML configuration:: publishing: library_settings: php_settings:// library_package: Google\Cloud\PubSub\V1LibraryPackagestring `json:"libraryPackage,omitempty"`// ForceSendFields is a list of field names (e.g. "Common") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Common") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PhpSettings: Settings for Php client libraries.

func (PhpSettings)MarshalJSONadded inv0.104.0

func (sPhpSettings) MarshalJSON() ([]byte,error)

typeProducerQuotaPolicyadded inv0.138.0

type ProducerQuotaPolicy struct {// Container: The cloud resource container at which the quota policy is// created. The format is `{container_type}/{container_number}`Containerstring `json:"container,omitempty"`// Dimensions:  If this map is nonempty, then this policy applies only to// specific values for dimensions defined in the limit unit. For example, a// policy on a limit with the unit `1/{project}/{region}` could contain an// entry with the key `region` and the value `us-east-1`; the policy is only// applied to quota consumed in that region. This map has the following// restrictions: * Keys that are not defined in the limit's unit are not valid// keys. Any string appearing in {brackets} in the unit (besides {project} or// {user}) is a defined key. * `project` is not a valid key; the project is// already specified in the parent resource name. * `user` is not a valid key;// the API does not support quota policies that apply only to a specific user.// * If `region` appears as a key, its value must be a valid Cloud region. * If// `zone` appears as a key, its value must be a valid Cloud zone. * If any// valid key other than `region` or `zone` appears in the map, then all valid// keys other than `region` or `zone` must also appear in the map.Dimensions map[string]string `json:"dimensions,omitempty"`// Metric: The name of the metric to which this policy applies. An example name// would be: `compute.googleapis.com/cpus`Metricstring `json:"metric,omitempty"`// Name: The resource name of the policy. This name is generated by the server// when the policy is created. Example names would be:// `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compu// te.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3// f2c1d`Namestring `json:"name,omitempty"`// PolicyValue: The quota policy value. Can be any nonnegative integer, or -1// (unlimited quota).PolicyValueint64 `json:"policyValue,omitempty,string"`// Unit: The limit unit of the limit to which this policy applies. An example// unit would be: `1/{project}/{region}` Note that `{project}` and `{region}`// are not placeholders in this example; the literal characters `{` and `}`// occur in the string.Unitstring `json:"unit,omitempty"`// ForceSendFields is a list of field names (e.g. "Container") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Container") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ProducerQuotaPolicy: Quota policy created by service producer.

func (ProducerQuotaPolicy)MarshalJSONadded inv0.138.0

func (sProducerQuotaPolicy) MarshalJSON() ([]byte,error)

typePublishingadded inv0.104.0

type Publishing struct {// 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".ApiShortNamestring `json:"apiShortName,omitempty"`// CodeownerGithubTeams: GitHub teams to be added to CODEOWNERS in the// directory in GitHub containing source code for the client libraries for this// API.CodeownerGithubTeams []string `json:"codeownerGithubTeams,omitempty"`// DocTagPrefix: A prefix used in sample code when demarking regions to be// included in documentation.DocTagPrefixstring `json:"docTagPrefix,omitempty"`// DocumentationUri: Link to product home page. Example://https://cloud.google.com/asset-inventory/docs/overviewDocumentationUristring `json:"documentationUri,omitempty"`// GithubLabel: GitHub label to apply to issues and pull requests opened for// this API.GithubLabelstring `json:"githubLabel,omitempty"`// 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.LibrarySettings []*ClientLibrarySettings `json:"librarySettings,omitempty"`// MethodSettings: A list of API method settings, e.g. the behavior for methods// that use the long-running operation pattern.MethodSettings []*MethodSettings `json:"methodSettings,omitempty"`// NewIssueUri: Link to a *public* URI where users can report issues. Example://https://issuetracker.google.com/issues/new?component=190865&template=1161103NewIssueUristring `json:"newIssueUri,omitempty"`// Organization: For whom the client library is being published.//// Possible values://   "CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED" - Not useful.//   "CLOUD" - Google Cloud Platform Org.//   "ADS" - Ads (Advertising) Org.//   "PHOTOS" - Photos Org.//   "STREET_VIEW" - Street View Org.//   "SHOPPING" - Shopping Org.//   "GEO" - Geo Org.//   "GENERATIVE_AI" - Generative AI -https://developers.generativeai.googleOrganizationstring `json:"organization,omitempty"`// ProtoReferenceDocumentationUri: Optional link to proto reference// documentation. Example://https://cloud.google.com/pubsub/lite/docs/reference/rpcProtoReferenceDocumentationUristring `json:"protoReferenceDocumentationUri,omitempty"`// RestReferenceDocumentationUri: Optional link to REST reference// documentation. Example://https://cloud.google.com/pubsub/lite/docs/reference/restRestReferenceDocumentationUristring `json:"restReferenceDocumentationUri,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiShortName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ApiShortName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Publishing: This message configures the settings for publishing Google CloudClient libraries (https://cloud.google.com/apis/docs/cloud-client-libraries)generated from the service config.

func (Publishing)MarshalJSONadded inv0.104.0

func (sPublishing) MarshalJSON() ([]byte,error)

typePythonSettingsadded inv0.104.0

type PythonSettings struct {// Common: Some settings.Common *CommonLanguageSettings `json:"common,omitempty"`// ExperimentalFeatures: Experimental features to be included during client// library generation.ExperimentalFeatures *ExperimentalFeatures `json:"experimentalFeatures,omitempty"`// ForceSendFields is a list of field names (e.g. "Common") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Common") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PythonSettings: Settings for Python client libraries.

func (PythonSettings)MarshalJSONadded inv0.104.0

func (sPythonSettings) MarshalJSON() ([]byte,error)

typeQuota

type Quota struct {// Limits: List of QuotaLimit definitions for the service.Limits []*QuotaLimit `json:"limits,omitempty"`// MetricRules: List of MetricRule definitions, each one mapping a selected// method to one or more metrics.MetricRules []*MetricRule `json:"metricRules,omitempty"`// ForceSendFields is a list of field names (e.g. "Limits") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Limits") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Quota: Quota configuration helps to achieve fairness and budgeting inservice usage. The metric based quota configuration works this way: - Theservice configuration defines a set of metrics. - For API calls, thequota.metric_rules maps methods to metrics with corresponding costs. - Thequota.limits defines limits on the metrics, which will be used for quotachecks at runtime. An example quota configuration in yaml format: quota:limits: - name: apiWriteQpsPerProject metric:library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit forconsumer projects values: STANDARD: 10000 (The metric rules bind all methodsto the read_calls metric, except for the UpdateBook and DeleteBook methods.These two methods are mapped to the write_calls metric, with the UpdateBookmethod consuming at twice rate as the DeleteBook method.) metric_rules: -selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector:google.example.library.v1.LibraryService.UpdateBook metric_costs:library.googleapis.com/write_calls: 2 - selector:google.example.library.v1.LibraryService.DeleteBook metric_costs:library.googleapis.com/write_calls: 1 Corresponding Metric definition:metrics: - name: library.googleapis.com/read_calls display_name: Readrequests metric_kind: DELTA value_type: INT64 - name:library.googleapis.com/write_calls display_name: Write requests metric_kind:DELTA value_type: INT64

func (Quota)MarshalJSON

func (sQuota) MarshalJSON() ([]byte,error)

typeQuotaBucketadded inv0.21.0

type QuotaBucket struct {// AdminOverride: Admin override on this quota bucket.AdminOverride *QuotaOverride `json:"adminOverride,omitempty"`// ConsumerOverride: Consumer override on this quota bucket.ConsumerOverride *QuotaOverride `json:"consumerOverride,omitempty"`// DefaultLimit: The default limit of this quota bucket, as specified by the// service configuration.DefaultLimitint64 `json:"defaultLimit,omitempty,string"`// Dimensions: The dimensions of this quota bucket. If this map is empty, this// is the global bucket, which is the default quota value applied to all// requests that do not have a more specific override. If this map is nonempty,// the default limit, effective limit, and quota overrides apply only to// requests that have the dimensions given in the map. For example, if the map// has key `region` and value `us-east-1`, then the specified effective limit// is only effective in that region, and the specified overrides apply only in// that region.Dimensions map[string]string `json:"dimensions,omitempty"`// EffectiveLimit: The effective limit of this quota bucket. Equal to// default_limit if there are no overrides.EffectiveLimitint64 `json:"effectiveLimit,omitempty,string"`// ProducerOverride: Producer override on this quota bucket.ProducerOverride *QuotaOverride `json:"producerOverride,omitempty"`// ProducerQuotaPolicy: Producer policy inherited from the closet ancestor of// the current consumer.ProducerQuotaPolicy *ProducerQuotaPolicy `json:"producerQuotaPolicy,omitempty"`// RolloutInfo: Rollout information of this quota bucket. This field is present// only if the effective limit will change due to the ongoing rollout of the// service config.RolloutInfo *RolloutInfo `json:"rolloutInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "AdminOverride") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdminOverride") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

QuotaBucket: A quota bucket is a quota provisioning unit for a specific setof dimensions.

func (QuotaBucket)MarshalJSONadded inv0.21.0

func (sQuotaBucket) MarshalJSON() ([]byte,error)

typeQuotaLimit

type QuotaLimit struct {// DefaultLimit: Default number of tokens that can be consumed during the// specified duration. This is the number of tokens assigned when a client// application developer activates the service for his/her project. Specifying// a value of 0 will block all requests. This can be used if you are// provisioning quota to selected consumers and blocking others. Similarly, a// value of -1 will indicate an unlimited quota. No other negative values are// allowed. Used by group-based quotas only.DefaultLimitint64 `json:"defaultLimit,omitempty,string"`// Description: Optional. User-visible, extended description for this quota// limit. Should be used only when more context is needed to understand this// limit than provided by the limit's display name (see: `display_name`).Descriptionstring `json:"description,omitempty"`// DisplayName: User-visible display name for this limit. Optional. If not set,// the UI will provide a default display name based on the quota configuration.// This field can be used to override the default display name generated from// the configuration.DisplayNamestring `json:"displayName,omitempty"`// Duration: Duration of this limit in textual notation. Must be "100s" or// "1d". Used by group-based quotas only.Durationstring `json:"duration,omitempty"`// FreeTier: Free tier value displayed in the Developers Console for this// limit. The free tier is the number of tokens that will be subtracted from// the billed amount when billing is enabled. This field can only be set on a// limit with duration "1d", in a billable group; it is invalid on any other// limit. If this field is not set, it defaults to 0, indicating that there is// no free tier for this service. Used by group-based quotas only.FreeTierint64 `json:"freeTier,omitempty,string"`// MaxLimit: Maximum number of tokens that can be consumed during the specified// duration. Client application developers can override the default limit up to// this maximum. If specified, this value cannot be set to a value less than// the default limit. If not specified, it is set to the default limit. To// allow clients to apply overrides with no upper bound, set this to -1,// indicating unlimited maximum quota. Used by group-based quotas only.MaxLimitint64 `json:"maxLimit,omitempty,string"`// Metric: The name of the metric this quota limit applies to. The quota limits// with the same metric will be checked together during runtime. The metric// must be defined within the service config.Metricstring `json:"metric,omitempty"`// Name: Name of the quota limit. The name must be provided, and it must be// unique within the service. The name can only include alphanumeric characters// as well as '-'. The maximum length of the limit name is 64 characters.Namestring `json:"name,omitempty"`// Unit: Specify the unit of the quota limit. It uses the same syntax as// MetricDescriptor.unit. The supported unit kinds are determined by the quota// backend system. Here are some examples: * "1/min/{project}" for quota per// minute per project. Note: the order of unit components is insignificant. The// "1" at the beginning is required to follow the metric unit syntax.Unitstring `json:"unit,omitempty"`// Values: Tiered limit values. You must specify this as a key:value pair, with// an integer value that is the maximum number of requests allowed for the// specified unit. Currently only STANDARD is supported.Values map[string]string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "DefaultLimit") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DefaultLimit") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

QuotaLimit: `QuotaLimit` defines a specific limit that applies over aspecified duration for a limit type. There can be at most one limit for aduration and limit type combination defined within a `QuotaGroup`.

func (QuotaLimit)MarshalJSON

func (sQuotaLimit) MarshalJSON() ([]byte,error)

typeQuotaOverrideadded inv0.4.0

type QuotaOverride struct {// AdminOverrideAncestor: The resource name of the ancestor that requested the// override. For example: `organizations/12345` or `folders/67890`. Used by// admin overrides only.AdminOverrideAncestorstring `json:"adminOverrideAncestor,omitempty"`// Dimensions: If this map is nonempty, then this override applies only to// specific values for dimensions defined in the limit unit. For example, an// override on a limit with the unit `1/{project}/{region}` could contain an// entry with the key `region` and the value `us-east-1`; the override is only// applied to quota consumed in that region. This map has the following// restrictions: * Keys that are not defined in the limit's unit are not valid// keys. Any string appearing in `{brackets}` in the unit (besides `{project}`// or `{user}`) is a defined key. * `project` is not a valid key; the project// is already specified in the parent resource name. * `user` is not a valid// key; the API does not support quota overrides that apply only to a specific// user. * If `region` appears as a key, its value must be a valid Cloud// region. * If `zone` appears as a key, its value must be a valid Cloud zone.// * If any valid key other than `region` or `zone` appears in the map, then// all valid keys other than `region` or `zone` must also appear in the map.Dimensions map[string]string `json:"dimensions,omitempty"`// Metric: The name of the metric to which this override applies. An example// name would be: `compute.googleapis.com/cpus`Metricstring `json:"metric,omitempty"`// Name: The resource name of the override. This name is generated by the// server when the override is created. Example names would be:// `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.go// ogleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`// `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.go// ogleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`// The resource name is intended to be opaque and should not be parsed for its// component strings, since its representation could change in the future.Namestring `json:"name,omitempty"`// OverrideValue: The overriding quota limit value. Can be any nonnegative// integer, or -1 (unlimited quota).OverrideValueint64 `json:"overrideValue,omitempty,string"`// Unit: The limit unit of the limit to which this override applies. An example// unit would be: `1/{project}/{region}` Note that `{project}` and `{region}`// are not placeholders in this example; the literal characters `{` and `}`// occur in the string.Unitstring `json:"unit,omitempty"`// ForceSendFields is a list of field names (e.g. "AdminOverrideAncestor") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdminOverrideAncestor") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

QuotaOverride: A quota override

func (QuotaOverride)MarshalJSONadded inv0.4.0

func (sQuotaOverride) MarshalJSON() ([]byte,error)

typeRemoveEnableRulesMetadataadded inv0.123.0

type RemoveEnableRulesMetadata struct {}

RemoveEnableRulesMetadata: Metadata for the `RemoveEnableRules` method.

typeRemoveEnableRulesResponseadded inv0.123.0

type RemoveEnableRulesResponse struct {// Parent: The parent consumer policy. It can be// `projects/12345/consumerPolicies/default`, or// `folders/12345/consumerPolicies/default`, or// `organizations/12345/consumerPolicies/default`.Parentstring `json:"parent,omitempty"`// RemovedValues: The values removed from the parent consumer policy.RemovedValues []string `json:"removedValues,omitempty"`// ForceSendFields is a list of field names (e.g. "Parent") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Parent") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RemoveEnableRulesResponse: The response message of `RemoveEnableRules`method.

func (RemoveEnableRulesResponse)MarshalJSONadded inv0.123.0

func (sRemoveEnableRulesResponse) MarshalJSON() ([]byte,error)

typeRolloutInfoadded inv0.169.0

type RolloutInfo struct {// DefaultLimitOngoingRollout: Whether there is an ongoing rollout for the// default limit or not.DefaultLimitOngoingRolloutbool `json:"defaultLimitOngoingRollout,omitempty"`// ForceSendFields is a list of field names (e.g. "DefaultLimitOngoingRollout")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DefaultLimitOngoingRollout") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RolloutInfo: [Output only] Rollout information of a quota.

func (RolloutInfo)MarshalJSONadded inv0.169.0

func (sRolloutInfo) MarshalJSON() ([]byte,error)

typeRubySettingsadded inv0.104.0

type RubySettings struct {// Common: Some settings.Common *CommonLanguageSettings `json:"common,omitempty"`// ForceSendFields is a list of field names (e.g. "Common") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Common") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RubySettings: Settings for Ruby client libraries.

func (RubySettings)MarshalJSONadded inv0.104.0

func (sRubySettings) MarshalJSON() ([]byte,error)

typeSelectiveGapicGenerationadded inv0.200.0

type SelectiveGapicGeneration struct {// GenerateOmittedAsInternal: Setting this to true indicates to the client// generators that methods that would be excluded from the generation should// instead be generated in a way that indicates these methods should not be// consumed by end users. How this is expressed is up to individual language// implementations to decide. Some examples may be: added annotations,// obfuscated identifiers, or other language idiomatic patterns.GenerateOmittedAsInternalbool `json:"generateOmittedAsInternal,omitempty"`// Methods: An allowlist of the fully qualified names of RPCs that should be// included on public client surfaces.Methods []string `json:"methods,omitempty"`// ForceSendFields is a list of field names (e.g. "GenerateOmittedAsInternal")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GenerateOmittedAsInternal") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (SelectiveGapicGeneration)MarshalJSONadded inv0.200.0

func (sSelectiveGapicGeneration) MarshalJSON() ([]byte,error)

typeService

type Service struct {// Config: The service configuration of the available service. Some fields may// be filtered out of the configuration in responses to the `ListServices`// method. These fields are present only in responses to the `GetService`// method.Config *ServiceConfig `json:"config,omitempty"`// Name: The resource name of the consumer and service. A valid name would be:// - `projects/123/services/serviceusage.googleapis.com`Namestring `json:"name,omitempty"`// Parent: The resource name of the consumer. A valid name would be: -// `projects/123`Parentstring `json:"parent,omitempty"`// State: Whether or not the service has been enabled for use by the consumer.//// Possible values://   "STATE_UNSPECIFIED" - The default value, which indicates that the enabled// state of the service is unspecified or not meaningful. Currently, all// consumers other than projects (such as folders and organizations) are always// in this state.//   "DISABLED" - The service cannot be used by this consumer. It has either// been explicitly disabled, or has never been enabled.//   "ENABLED" - The service has been explicitly enabled for use by this// consumer.Statestring `json:"state,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Config") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Config") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Service: A service that is available for use by the consumer.

func (Service)MarshalJSON

func (sService) MarshalJSON() ([]byte,error)

typeServiceConfig

type ServiceConfig struct {// Apis: A list of API interfaces exported by this service. Contains only the// names, versions, and method names of the interfaces.Apis []*Api `json:"apis,omitempty"`// Authentication: Auth configuration. Contains only the OAuth rules.Authentication *Authentication `json:"authentication,omitempty"`// Documentation: Additional API documentation. Contains only the summary and// the documentation URL.Documentation *Documentation `json:"documentation,omitempty"`// Endpoints: Configuration for network endpoints. Contains only the names and// aliases of the endpoints.Endpoints []*Endpoint `json:"endpoints,omitempty"`// MonitoredResources: Defines the monitored resources used by this service.// This is required by the Service.monitoring and Service.logging// configurations.MonitoredResources []*MonitoredResourceDescriptor `json:"monitoredResources,omitempty"`// Monitoring: Monitoring configuration. This should not include the// 'producer_destinations' field.Monitoring *Monitoring `json:"monitoring,omitempty"`// Name: The DNS address at which this service is available. An example DNS// address would be: `calendar.googleapis.com`.Namestring `json:"name,omitempty"`// Quota: Quota configuration.Quota *Quota `json:"quota,omitempty"`// Title: The product title for this service.Titlestring `json:"title,omitempty"`// Usage: Configuration controlling usage of this service.Usage *Usage `json:"usage,omitempty"`// ForceSendFields is a list of field names (e.g. "Apis") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Apis") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ServiceConfig: The configuration of the service.

func (ServiceConfig)MarshalJSON

func (sServiceConfig) MarshalJSON() ([]byte,error)

typeServiceIdentityadded inv0.10.0

type ServiceIdentity struct {// Email: The email address of the service account that a service producer// would use to access consumer resources.Emailstring `json:"email,omitempty"`// UniqueId: The unique and stable id of the service account.//https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccountUniqueIdstring `json:"uniqueId,omitempty"`// ForceSendFields is a list of field names (e.g. "Email") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Email") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ServiceIdentity: Service identity for a service. This is the identity thatservice producer should use to access consumer resources.

func (ServiceIdentity)MarshalJSONadded inv0.10.0

func (sServiceIdentity) MarshalJSON() ([]byte,error)

typeServicesBatchEnableCall

type ServicesBatchEnableCall struct {// contains filtered or unexported fields}

func (*ServicesBatchEnableCall)Context

Context sets the context to be used in this call's Do method.

func (*ServicesBatchEnableCall)Do

Do executes the "serviceusage.services.batchEnable" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesBatchEnableCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesBatchEnableCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesConsumerQuotaMetricsGetCalladded inv0.21.0

type ServicesConsumerQuotaMetricsGetCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsGetCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsGetCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.get" call.Any non-2xx status code is an error. Response headers are in either*ConsumerQuotaMetric.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ServicesConsumerQuotaMetricsGetCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsGetCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesConsumerQuotaMetricsGetCall)IfNoneMatchadded inv0.21.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesConsumerQuotaMetricsGetCall)Viewadded inv0.21.0

View sets the optional parameter "view": Specifies the level of detail forquota information in the response.

Possible values:

"QUOTA_VIEW_UNSPECIFIED" - No quota view specified. Requests that do not

specify a quota view will typically default to the BASIC view.

"BASIC" - Only buckets with overrides are shown in the response."FULL" - Include per-location buckets even if they do not have overrides.

When the view is FULL, and a limit has regional or zonal quota, the limitwill include buckets for all regions or zones that could support overrides,even if none are currently present. In some cases this will cause theresponse to become very large; callers that do not need this extrainformation should use the BASIC view instead.

typeServicesConsumerQuotaMetricsImportAdminOverridesCalladded inv0.35.0

type ServicesConsumerQuotaMetricsImportAdminOverridesCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsImportAdminOverridesCall)Contextadded inv0.35.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsImportAdminOverridesCall)Doadded inv0.35.0

Do executes the "serviceusage.services.consumerQuotaMetrics.importAdminOverrides" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsImportAdminOverridesCall)Fieldsadded inv0.35.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsImportAdminOverridesCall)Headeradded inv0.35.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesConsumerQuotaMetricsImportConsumerOverridesCalladded inv0.28.0

type ServicesConsumerQuotaMetricsImportConsumerOverridesCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsImportConsumerOverridesCall)Contextadded inv0.28.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsImportConsumerOverridesCall)Doadded inv0.28.0

Do executes the "serviceusage.services.consumerQuotaMetrics.importConsumerOverrides" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsImportConsumerOverridesCall)Fieldsadded inv0.28.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsImportConsumerOverridesCall)Headeradded inv0.28.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesConsumerQuotaMetricsLimitsAdminOverridesCreateCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsAdminOverridesCreateCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesCreateCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesCreateCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.create" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesCreateCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesCreateCall)Forceadded inv0.21.0

Force sets the optional parameter "force": Whether to force the creation ofthe quota override. Setting the force parameter to 'true' ignores all quotasafety checks that would fail the request. QuotaSafetyCheck lists all suchvalidations. If force is set to true, it is recommended to include a case idin "X-Goog-Request-Reason" header when sending the request.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesCreateCall)ForceOnlyadded inv0.38.0

ForceOnly sets the optional parameter "forceOnly": The list of quota safetychecks to ignore before the override mutation. Unlike 'force' field thatignores all the quota safety checks, the 'force_only' field ignores only thespecified checks; other checks are still enforced. The 'force' and'force_only' fields cannot both be set. If force_only is specified, it isrecommended to include a case id in "X-Goog-Request-Reason" header whensending the request.

Possible values:

"QUOTA_SAFETY_CHECK_UNSPECIFIED" - Unspecified quota safety check."LIMIT_DECREASE_BELOW_USAGE" - Validates that a quota mutation would not

cause the consumer's effective limit to be lower than the consumer's quotausage.

"LIMIT_DECREASE_PERCENTAGE_TOO_HIGH" - Validates that a quota mutation

would not cause the consumer's effective limit to decrease by more than 10percent.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesCreateCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesConsumerQuotaMetricsLimitsAdminOverridesDeleteCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsAdminOverridesDeleteCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesDeleteCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesDeleteCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.delete" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesDeleteCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesDeleteCall)Forceadded inv0.21.0

Force sets the optional parameter "force": Whether to force the deletion ofthe quota override. Setting the force parameter to 'true' ignores all quotasafety checks that would fail the request. QuotaSafetyCheck lists all suchvalidations. If force is set to true, it is recommended to include a case idin "X-Goog-Request-Reason" header when sending the request.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesDeleteCall)ForceOnlyadded inv0.38.0

ForceOnly sets the optional parameter "forceOnly": The list of quota safetychecks to ignore before the override mutation. Unlike 'force' field thatignores all the quota safety checks, the 'force_only' field ignores only thespecified checks; other checks are still enforced. The 'force' and'force_only' fields cannot both be set. If force_only is specified, it isrecommended to include a case id in "X-Goog-Request-Reason" header whensending the request.

Possible values:

"QUOTA_SAFETY_CHECK_UNSPECIFIED" - Unspecified quota safety check."LIMIT_DECREASE_BELOW_USAGE" - Validates that a quota mutation would not

cause the consumer's effective limit to be lower than the consumer's quotausage.

"LIMIT_DECREASE_PERCENTAGE_TOO_HIGH" - Validates that a quota mutation

would not cause the consumer's effective limit to decrease by more than 10percent.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesDeleteCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesConsumerQuotaMetricsLimitsAdminOverridesListCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.list" call.Any non-2xx status code is an error. Response headers are in either*ListAdminOverridesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall)IfNoneMatchadded inv0.21.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall)PageSizeadded inv0.21.0

PageSize sets the optional parameter "pageSize": Requested size of the nextpage of data.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall)PageTokenadded inv0.21.0

PageToken sets the optional parameter "pageToken": Token identifying whichresult to start with; returned by a previous list call.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesListCall)Pagesadded inv0.21.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.patch" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCall)Forceadded inv0.21.0

Force sets the optional parameter "force": Whether to force the update ofthe quota override. Setting the force parameter to 'true' ignores all quotasafety checks that would fail the request. QuotaSafetyCheck lists all suchvalidations. If force is set to true, it is recommended to include a case idin "X-Goog-Request-Reason" header when sending the request.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCall)ForceOnlyadded inv0.38.0

ForceOnly sets the optional parameter "forceOnly": The list of quota safetychecks to ignore before the override mutation. Unlike 'force' field thatignores all the quota safety checks, the 'force_only' field ignores only thespecified checks; other checks are still enforced. The 'force' and'force_only' fields cannot both be set. If force_only is specified, it isrecommended to include a case id in "X-Goog-Request-Reason" header whensending the request.

Possible values:

"QUOTA_SAFETY_CHECK_UNSPECIFIED" - Unspecified quota safety check."LIMIT_DECREASE_BELOW_USAGE" - Validates that a quota mutation would not

cause the consumer's effective limit to be lower than the consumer's quotausage.

"LIMIT_DECREASE_PERCENTAGE_TOO_HIGH" - Validates that a quota mutation

would not cause the consumer's effective limit to decrease by more than 10percent.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesPatchCall)UpdateMaskadded inv0.21.0

UpdateMask sets the optional parameter "updateMask": Update only thespecified fields of the override. If unset, all fields will be updated.

typeServicesConsumerQuotaMetricsLimitsAdminOverridesServiceadded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsAdminOverridesService struct {// contains filtered or unexported fields}

funcNewServicesConsumerQuotaMetricsLimitsAdminOverridesServiceadded inv0.21.0

func NewServicesConsumerQuotaMetricsLimitsAdminOverridesService(s *APIService) *ServicesConsumerQuotaMetricsLimitsAdminOverridesService

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesService)Createadded inv0.21.0

Create: Creates an admin override. An admin override is applied by anadministrator of a parent folder or parent organization of the consumerreceiving the override. An admin override is intended to limit the amount ofquota the consumer can use out of the total quota pool allocated to allchildren of the folder or organization.

  • parent: The resource name of the parent quota limit, returned by aListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example namewould be:`projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesService)Deleteadded inv0.21.0

Delete: Deletes an admin override.

  • name: The resource name of the override to delete. An example name wouldbe:`projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesService)Listadded inv0.21.0

List: Lists all admin overrides on this limit.

  • parent: The resource name of the parent quota limit, returned by aListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example namewould be:`projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`.

func (*ServicesConsumerQuotaMetricsLimitsAdminOverridesService)Patchadded inv0.21.0

Patch: Updates an admin override.

  • name: The resource name of the override to update. An example name wouldbe:`projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`.

typeServicesConsumerQuotaMetricsLimitsConsumerOverridesCreateCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsConsumerOverridesCreateCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesCreateCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesCreateCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.create" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesCreateCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesCreateCall)Forceadded inv0.21.0

Force sets the optional parameter "force": Whether to force the creation ofthe quota override. Setting the force parameter to 'true' ignores all quotasafety checks that would fail the request. QuotaSafetyCheck lists all suchvalidations. If force is set to true, it is recommended to include a case idin "X-Goog-Request-Reason" header when sending the request.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesCreateCall)ForceOnlyadded inv0.38.0

ForceOnly sets the optional parameter "forceOnly": The list of quota safetychecks to ignore before the override mutation. Unlike 'force' field thatignores all the quota safety checks, the 'force_only' field ignores only thespecified checks; other checks are still enforced. The 'force' and'force_only' fields cannot both be set. If force_only is specified, it isrecommended to include a case id in "X-Goog-Request-Reason" header whensending the request.

Possible values:

"QUOTA_SAFETY_CHECK_UNSPECIFIED" - Unspecified quota safety check."LIMIT_DECREASE_BELOW_USAGE" - Validates that a quota mutation would not

cause the consumer's effective limit to be lower than the consumer's quotausage.

"LIMIT_DECREASE_PERCENTAGE_TOO_HIGH" - Validates that a quota mutation

would not cause the consumer's effective limit to decrease by more than 10percent.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesCreateCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesConsumerQuotaMetricsLimitsConsumerOverridesDeleteCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsConsumerOverridesDeleteCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesDeleteCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesDeleteCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.delete" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesDeleteCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesDeleteCall)Forceadded inv0.21.0

Force sets the optional parameter "force": Whether to force the deletion ofthe quota override. Setting the force parameter to 'true' ignores all quotasafety checks that would fail the request. QuotaSafetyCheck lists all suchvalidations. If force is set to true, it is recommended to include a case idin "X-Goog-Request-Reason" header when sending the request.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesDeleteCall)ForceOnlyadded inv0.38.0

ForceOnly sets the optional parameter "forceOnly": The list of quota safetychecks to ignore before the override mutation. Unlike 'force' field thatignores all the quota safety checks, the 'force_only' field ignores only thespecified checks; other checks are still enforced. The 'force' and'force_only' fields cannot both be set. If force_only is specified, it isrecommended to include a case id in "X-Goog-Request-Reason" header whensending the request.

Possible values:

"QUOTA_SAFETY_CHECK_UNSPECIFIED" - Unspecified quota safety check."LIMIT_DECREASE_BELOW_USAGE" - Validates that a quota mutation would not

cause the consumer's effective limit to be lower than the consumer's quotausage.

"LIMIT_DECREASE_PERCENTAGE_TOO_HIGH" - Validates that a quota mutation

would not cause the consumer's effective limit to decrease by more than 10percent.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesDeleteCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesConsumerQuotaMetricsLimitsConsumerOverridesListCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.list" call.Any non-2xx status code is an error. Response headers are in either*ListConsumerOverridesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall)IfNoneMatchadded inv0.21.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall)PageSizeadded inv0.21.0

PageSize sets the optional parameter "pageSize": Requested size of the nextpage of data.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall)PageTokenadded inv0.21.0

PageToken sets the optional parameter "pageToken": Token identifying whichresult to start with; returned by a previous list call.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesListCall)Pagesadded inv0.21.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.patch" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCall)Forceadded inv0.21.0

Force sets the optional parameter "force": Whether to force the update ofthe quota override. Setting the force parameter to 'true' ignores all quotasafety checks that would fail the request. QuotaSafetyCheck lists all suchvalidations. If force is set to true, it is recommended to include a case idin "X-Goog-Request-Reason" header when sending the request.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCall)ForceOnlyadded inv0.38.0

ForceOnly sets the optional parameter "forceOnly": The list of quota safetychecks to ignore before the override mutation. Unlike 'force' field thatignores all the quota safety checks, the 'force_only' field ignores only thespecified checks; other checks are still enforced. The 'force' and'force_only' fields cannot both be set. If force_only is specified, it isrecommended to include a case id in "X-Goog-Request-Reason" header whensending the request.

Possible values:

"QUOTA_SAFETY_CHECK_UNSPECIFIED" - Unspecified quota safety check."LIMIT_DECREASE_BELOW_USAGE" - Validates that a quota mutation would not

cause the consumer's effective limit to be lower than the consumer's quotausage.

"LIMIT_DECREASE_PERCENTAGE_TOO_HIGH" - Validates that a quota mutation

would not cause the consumer's effective limit to decrease by more than 10percent.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesPatchCall)UpdateMaskadded inv0.21.0

UpdateMask sets the optional parameter "updateMask": Update only thespecified fields of the override. If unset, all fields will be updated.

typeServicesConsumerQuotaMetricsLimitsConsumerOverridesServiceadded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsConsumerOverridesService struct {// contains filtered or unexported fields}

funcNewServicesConsumerQuotaMetricsLimitsConsumerOverridesServiceadded inv0.21.0

func NewServicesConsumerQuotaMetricsLimitsConsumerOverridesService(s *APIService) *ServicesConsumerQuotaMetricsLimitsConsumerOverridesService

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesService)Createadded inv0.21.0

Create: Creates a consumer override. A consumer override is applied to theconsumer on its own authority to limit its own quota usage. Consumeroverrides cannot be used to grant more quota than would be allowed by adminoverrides, producer overrides, or the default limit of the service.

  • parent: The resource name of the parent quota limit, returned by aListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example namewould be:`projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesService)Deleteadded inv0.21.0

Delete: Deletes a consumer override.

  • name: The resource name of the override to delete. An example name wouldbe:`projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesService)Listadded inv0.21.0

List: Lists all consumer overrides on this limit.

  • parent: The resource name of the parent quota limit, returned by aListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example namewould be:`projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`.

func (*ServicesConsumerQuotaMetricsLimitsConsumerOverridesService)Patchadded inv0.21.0

Patch: Updates a consumer override.

  • name: The resource name of the override to update. An example name wouldbe:`projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`.

typeServicesConsumerQuotaMetricsLimitsGetCalladded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsGetCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsLimitsGetCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsLimitsGetCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.limits.get" call.Any non-2xx status code is an error. Response headers are in either*ConsumerQuotaLimit.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ServicesConsumerQuotaMetricsLimitsGetCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsLimitsGetCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesConsumerQuotaMetricsLimitsGetCall)IfNoneMatchadded inv0.21.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesConsumerQuotaMetricsLimitsGetCall)Viewadded inv0.21.0

View sets the optional parameter "view": Specifies the level of detail forquota information in the response.

Possible values:

"QUOTA_VIEW_UNSPECIFIED" - No quota view specified. Requests that do not

specify a quota view will typically default to the BASIC view.

"BASIC" - Only buckets with overrides are shown in the response."FULL" - Include per-location buckets even if they do not have overrides.

When the view is FULL, and a limit has regional or zonal quota, the limitwill include buckets for all regions or zones that could support overrides,even if none are currently present. In some cases this will cause theresponse to become very large; callers that do not need this extrainformation should use the BASIC view instead.

typeServicesConsumerQuotaMetricsLimitsServiceadded inv0.21.0

type ServicesConsumerQuotaMetricsLimitsService struct {AdminOverrides *ServicesConsumerQuotaMetricsLimitsAdminOverridesServiceConsumerOverrides *ServicesConsumerQuotaMetricsLimitsConsumerOverridesService// contains filtered or unexported fields}

funcNewServicesConsumerQuotaMetricsLimitsServiceadded inv0.21.0

func NewServicesConsumerQuotaMetricsLimitsService(s *APIService) *ServicesConsumerQuotaMetricsLimitsService

func (*ServicesConsumerQuotaMetricsLimitsService)Getadded inv0.21.0

Get: Retrieves a summary of quota information for a specific quota limit.

  • name: The resource name of the quota limit. Use the quota limit resourcename returned by previous ListConsumerQuotaMetrics andGetConsumerQuotaMetric API calls.

typeServicesConsumerQuotaMetricsListCalladded inv0.21.0

type ServicesConsumerQuotaMetricsListCall struct {// contains filtered or unexported fields}

func (*ServicesConsumerQuotaMetricsListCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method.

func (*ServicesConsumerQuotaMetricsListCall)Doadded inv0.21.0

Do executes the "serviceusage.services.consumerQuotaMetrics.list" call.Any non-2xx status code is an error. Response headers are in either*ListConsumerQuotaMetricsResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ServicesConsumerQuotaMetricsListCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesConsumerQuotaMetricsListCall)Headeradded inv0.21.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesConsumerQuotaMetricsListCall)IfNoneMatchadded inv0.21.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesConsumerQuotaMetricsListCall)PageSizeadded inv0.21.0

PageSize sets the optional parameter "pageSize": Requested size of the nextpage of data.

func (*ServicesConsumerQuotaMetricsListCall)PageTokenadded inv0.21.0

PageToken sets the optional parameter "pageToken": Token identifying whichresult to start with; returned by a previous list call.

func (*ServicesConsumerQuotaMetricsListCall)Pagesadded inv0.21.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ServicesConsumerQuotaMetricsListCall)Viewadded inv0.21.0

View sets the optional parameter "view": Specifies the level of detail forquota information in the response.

Possible values:

"QUOTA_VIEW_UNSPECIFIED" - No quota view specified. Requests that do not

specify a quota view will typically default to the BASIC view.

"BASIC" - Only buckets with overrides are shown in the response."FULL" - Include per-location buckets even if they do not have overrides.

When the view is FULL, and a limit has regional or zonal quota, the limitwill include buckets for all regions or zones that could support overrides,even if none are currently present. In some cases this will cause theresponse to become very large; callers that do not need this extrainformation should use the BASIC view instead.

typeServicesConsumerQuotaMetricsServiceadded inv0.21.0

type ServicesConsumerQuotaMetricsService struct {Limits *ServicesConsumerQuotaMetricsLimitsService// contains filtered or unexported fields}

funcNewServicesConsumerQuotaMetricsServiceadded inv0.21.0

func NewServicesConsumerQuotaMetricsService(s *APIService) *ServicesConsumerQuotaMetricsService

func (*ServicesConsumerQuotaMetricsService)Getadded inv0.21.0

Get: Retrieves a summary of quota information for a specific quota metric

  • name: The resource name of the quota. An example name would be:`projects/123/services/serviceusage.googleapis.com/consumerQuotaMetrics/serviceusage.googleapis.com%2Fmutate_requests`.

func (*ServicesConsumerQuotaMetricsService)ImportAdminOverridesadded inv0.35.0

ImportAdminOverrides: Creates or updates multiple admin overridesatomically, all on the same consumer, but on many different metrics orlimits. The name field in the quota override message should not be set.

  • parent: The resource name of the consumer. An example name would be:`projects/123/services/compute.googleapis.com`.

func (*ServicesConsumerQuotaMetricsService)ImportConsumerOverridesadded inv0.28.0

ImportConsumerOverrides: Creates or updates multiple consumer overridesatomically, all on the same consumer, but on many different metrics orlimits. The name field in the quota override message should not be set.

  • parent: The resource name of the consumer. An example name would be:`projects/123/services/compute.googleapis.com`.

func (*ServicesConsumerQuotaMetricsService)Listadded inv0.21.0

List: Retrieves a summary of all quota information visible to the serviceconsumer, organized by service metric. Each metric includes informationabout all of its defined limits. Each limit includes the limit configuration(quota unit, preciseness, default value), the current effective limit value,and all of the overrides applied to the limit.

  • parent: Parent of the quotas resource. Some example names would be:`projects/123/services/serviceconsumermanagement.googleapis.com``folders/345/services/serviceconsumermanagement.googleapis.com``organizations/456/services/serviceconsumermanagement.googleapis.com`.

typeServicesDisableCall

type ServicesDisableCall struct {// contains filtered or unexported fields}

func (*ServicesDisableCall)Context

Context sets the context to be used in this call's Do method.

func (*ServicesDisableCall)Do

Do executes the "serviceusage.services.disable" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesDisableCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesDisableCall)Header

func (c *ServicesDisableCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesEnableCall

type ServicesEnableCall struct {// contains filtered or unexported fields}

func (*ServicesEnableCall)Context

Context sets the context to be used in this call's Do method.

func (*ServicesEnableCall)Do

Do executes the "serviceusage.services.enable" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesEnableCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesEnableCall)Header

func (c *ServicesEnableCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesGenerateServiceIdentityCalladded inv0.27.0

type ServicesGenerateServiceIdentityCall struct {// contains filtered or unexported fields}

func (*ServicesGenerateServiceIdentityCall)Contextadded inv0.27.0

Context sets the context to be used in this call's Do method.

func (*ServicesGenerateServiceIdentityCall)Doadded inv0.27.0

Do executes the "serviceusage.services.generateServiceIdentity" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesGenerateServiceIdentityCall)Fieldsadded inv0.27.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesGenerateServiceIdentityCall)Headeradded inv0.27.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesGetCall

type ServicesGetCall struct {// contains filtered or unexported fields}

func (*ServicesGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ServicesGetCall)Do

Do executes the "serviceusage.services.get" call.Any non-2xx status code is an error. Response headers are in either*Service.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesGetCall)Header

func (c *ServicesGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesGetCall)IfNoneMatch

func (c *ServicesGetCall) IfNoneMatch(entityTagstring) *ServicesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeServicesListCall

type ServicesListCall struct {// contains filtered or unexported fields}

func (*ServicesListCall)Context

Context sets the context to be used in this call's Do method.

func (*ServicesListCall)Do

Do executes the "serviceusage.services.list" call.Any non-2xx status code is an error. Response headers are in either*ListServicesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ServicesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesListCall)Filter

func (c *ServicesListCall) Filter(filterstring) *ServicesListCall

Filter sets the optional parameter "filter": Only list services that conformto the given filter. The allowed filter strings are `state:ENABLED` and`state:DISABLED`.

func (*ServicesListCall)Header

func (c *ServicesListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesListCall)IfNoneMatch

func (c *ServicesListCall) IfNoneMatch(entityTagstring) *ServicesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesListCall)PageSize

func (c *ServicesListCall) PageSize(pageSizeint64) *ServicesListCall

PageSize sets the optional parameter "pageSize": Requested size of the nextpage of data. Requested page size cannot exceed 200. If not set, the defaultpage size is 50.

func (*ServicesListCall)PageToken

func (c *ServicesListCall) PageToken(pageTokenstring) *ServicesListCall

PageToken sets the optional parameter "pageToken": Token identifying whichresult to start with, which is returned by a previous list call.

func (*ServicesListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeServicesService

type ServicesService struct {ConsumerQuotaMetrics *ServicesConsumerQuotaMetricsService// contains filtered or unexported fields}

funcNewServicesService

func NewServicesService(s *APIService) *ServicesService

func (*ServicesService)BatchEnable

func (r *ServicesService) BatchEnable(parentstring, batchenableservicesrequest *BatchEnableServicesRequest) *ServicesBatchEnableCall

BatchEnable: Enables multiple services on a project. The operation isatomic: if enabling any service fails, then the entire batch fails, and nostate changes occur. Operation response type: `google.protobuf.Empty`

  • parent: Parent to enable services on. An example name would be:`projects/123` where `123` is the project number (not project ID). The`BatchEnableServices` method currently only supports projects.

func (*ServicesService)Disable

func (r *ServicesService) Disable(namestring, disableservicerequest *DisableServiceRequest) *ServicesDisableCall

Disable: Disables a service so that it can no longer be used with a project.This prevents unintended usage that may cause unexpected billing charges orsecurity leaks. It is not valid to call the disable method on a service thatis not currently enabled. Callers will receive a `FAILED_PRECONDITION`status if the target service is not currently enabled. Operation responsetype: `google.protobuf.Empty`

  • name: Name of the consumer and service to disable the service on. Theenable and disable methods currently only support projects. An examplename would be: `projects/123/services/serviceusage.googleapis.com` where`123` is the project number (not project ID).

func (*ServicesService)Enable

func (r *ServicesService) Enable(namestring, enableservicerequest *EnableServiceRequest) *ServicesEnableCall

Enable: Enables a service so that it can be used with a project. Operationresponse type: `google.protobuf.Empty`

  • name: Name of the consumer and service to enable the service on. The`EnableService` and `DisableService` methods currently only supportprojects. Enabling a service requires that the service is public or isshared with the user enabling the service. An example name would be:`projects/123/services/serviceusage.googleapis.com` where `123` is theproject number (not project ID).

func (*ServicesService)GenerateServiceIdentityadded inv0.27.0

func (r *ServicesService) GenerateServiceIdentity(parentstring) *ServicesGenerateServiceIdentityCall

GenerateServiceIdentity: Generates service identity for service.

  • parent: Name of the consumer and service to generate an identity for. The`GenerateServiceIdentity` methods currently support projects, folders,organizations. Example parents would be:`projects/123/services/example.googleapis.com``folders/123/services/example.googleapis.com``organizations/123/services/example.googleapis.com`.

func (*ServicesService)Get

Get: Returns the service configuration and enabled state for a givenservice.

  • name: Name of the consumer and service to get the `ConsumerState` for. Anexample name would be: `projects/123/services/serviceusage.googleapis.com`where `123` is the project number (not project ID).

func (*ServicesService)List

func (r *ServicesService) List(parentstring) *ServicesListCall

List: Lists all services available to the specified project, and the currentstate of those services with respect to the project. The list includes allpublic services, all services for which the calling user has the`servicemanagement.services.bind` permission, and all services that havealready been enabled on the project. The list can be filtered to onlyinclude services in a specific state, for example to only include servicesenabled on the project.

  • parent: Parent to search for services on. An example name would be:`projects/123` where `123` is the project number (not project ID).

typeSourceContext

type SourceContext struct {// FileName: The path-qualified name of the .proto file that contained the// associated protobuf element. For example:// "google/protobuf/source_context.proto".FileNamestring `json:"fileName,omitempty"`// ForceSendFields is a list of field names (e.g. "FileName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FileName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SourceContext: `SourceContext` represents information about the source of aprotobuf element, like the file in which it is defined.

func (SourceContext)MarshalJSON

func (sSourceContext) MarshalJSON() ([]byte,error)

typeSourceInfo

type SourceInfo struct {// SourceFiles: All files used during config generation.SourceFiles []googleapi.RawMessage `json:"sourceFiles,omitempty"`// ForceSendFields is a list of field names (e.g. "SourceFiles") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SourceFiles") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SourceInfo: Source information used to create a Service Config

func (SourceInfo)MarshalJSON

func (sSourceInfo) MarshalJSON() ([]byte,error)

typeStatus

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSON

func (sStatus) MarshalJSON() ([]byte,error)

typeSystemParameter

type SystemParameter struct {// HttpHeader: Define the HTTP header name to use for the parameter. It is case// insensitive.HttpHeaderstring `json:"httpHeader,omitempty"`// Name: Define the name of the parameter, such as "api_key" . It is case// sensitive.Namestring `json:"name,omitempty"`// UrlQueryParameter: Define the URL query parameter name to use for the// parameter. It is case sensitive.UrlQueryParameterstring `json:"urlQueryParameter,omitempty"`// ForceSendFields is a list of field names (e.g. "HttpHeader") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HttpHeader") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SystemParameter: Define a parameter's name and location. The parameter maybe passed as either an HTTP header or a URL query parameter, and if both arepassed the behavior is implementation-dependent.

func (SystemParameter)MarshalJSON

func (sSystemParameter) MarshalJSON() ([]byte,error)

typeSystemParameterRule

type SystemParameterRule struct {// Parameters: Define parameters. Multiple names may be defined for a// parameter. For a given method call, only one of them should be used. If// multiple names are used the behavior is implementation-dependent. If none of// the specified names are present the behavior is parameter-dependent.Parameters []*SystemParameter `json:"parameters,omitempty"`// Selector: Selects the methods to which this rule applies. Use '*' to// indicate all methods in all APIs. Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "Parameters") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Parameters") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SystemParameterRule: Define a system parameter rule mapping system parameterdefinitions to methods.

func (SystemParameterRule)MarshalJSON

func (sSystemParameterRule) MarshalJSON() ([]byte,error)

typeSystemParameters

type SystemParameters struct {// Rules: Define system parameters. The parameters defined here will override// the default parameters implemented by the system. If this field is missing// from the service config, default system parameters will be used. Default// system parameters and names is implementation-dependent. Example: define api// key for all methods system_parameters rules: - selector: "*" parameters: -// name: api_key url_query_parameter: api_key Example: define 2 api key names// for a specific method. system_parameters rules: - selector: "/ListShelves"// parameters: - name: api_key http_header: Api-Key1 - name: api_key// http_header: Api-Key2 **NOTE:** All service configuration rules follow "last// one wins" order.Rules []*SystemParameterRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g. "Rules") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Rules") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SystemParameters: ### System parameter configuration A system parameter is aspecial kind of parameter defined by the API system, not by an individualAPI. It is typically mapped to an HTTP header and/or a URL query parameter.This configuration specifies which methods change the names of the systemparameters.

func (SystemParameters)MarshalJSON

func (sSystemParameters) MarshalJSON() ([]byte,error)

typeType

type Type struct {// Edition: The source edition string, only valid when syntax is// SYNTAX_EDITIONS.Editionstring `json:"edition,omitempty"`// Fields: The list of fields.Fields []*Field `json:"fields,omitempty"`// Name: The fully qualified message name.Namestring `json:"name,omitempty"`// Oneofs: The list of types appearing in `oneof` definitions in this type.Oneofs []string `json:"oneofs,omitempty"`// Options: The protocol buffer options.Options []*Option `json:"options,omitempty"`// SourceContext: The source context.SourceContext *SourceContext `json:"sourceContext,omitempty"`// Syntax: The source syntax.//// Possible values://   "SYNTAX_PROTO2" - Syntax `proto2`.//   "SYNTAX_PROTO3" - Syntax `proto3`.//   "SYNTAX_EDITIONS" - Syntax `editions`.Syntaxstring `json:"syntax,omitempty"`// ForceSendFields is a list of field names (e.g. "Edition") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Edition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Type: A protocol buffer message type. New usages of this message as analternative to DescriptorProto are strongly discouraged. This message doesnot reliability preserve all information necessary to model the schema andpreserve semantics. Instead make use of FileDescriptorSet which preservesthe necessary information.

func (Type)MarshalJSON

func (sType) MarshalJSON() ([]byte,error)

typeUpdateAdminQuotaPolicyMetadataadded inv0.45.0

type UpdateAdminQuotaPolicyMetadata struct {}

UpdateAdminQuotaPolicyMetadata: Metadata message that provides informationsuch as progress, partial failures, and similar information on eachGetOperation call of LRO returned by UpdateAdminQuotaPolicy.

typeUpdateConsumerPolicyMetadataadded inv0.131.0

type UpdateConsumerPolicyMetadata struct {}

UpdateConsumerPolicyMetadata: Metadata for the `UpdateConsumerPolicy`method.

typeUpdateContentSecurityPolicyMetadataadded inv0.255.0

type UpdateContentSecurityPolicyMetadata struct {}

UpdateContentSecurityPolicyMetadata: Metadata for the`UpdateContentSecurityPolicy` method.

typeUpdateMcpPolicyMetadataadded inv0.250.0

type UpdateMcpPolicyMetadata struct {}

UpdateMcpPolicyMetadata: Metadata for the `UpdateMcpPolicy` method.

typeUsage

type Usage struct {// ProducerNotificationChannel: The full resource name of a channel used for// sending notifications to the service producer. Google Service Management// currently only supports Google Cloud Pub/Sub// (https://cloud.google.com/pubsub) as a notification channel. To use Google// Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic// that uses the Cloud Pub/Sub topic name format documented in//https://cloud.google.com/pubsub/docs/overview.ProducerNotificationChannelstring `json:"producerNotificationChannel,omitempty"`// Requirements: Requirements that must be satisfied before a consumer project// can use the service. Each requirement is of the form /; for example// 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of// Service requirement must be included here. Google Cloud APIs must include// "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include// "serviceusage.googleapis.com/tos/universal". Additional ToS can be included// based on the business needs.Requirements []string `json:"requirements,omitempty"`// Rules: A list of usage rules that apply to individual API methods. **NOTE:**// All service configuration rules follow "last one wins" order.Rules []*UsageRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g.// "ProducerNotificationChannel") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProducerNotificationChannel") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Usage: Configuration controlling usage of a service.

func (Usage)MarshalJSON

func (sUsage) MarshalJSON() ([]byte,error)

typeUsageRule

type UsageRule struct {// AllowUnregisteredCalls:  Use this rule to configure unregistered calls for// the service. Unregistered calls are calls that do not contain consumer// project identity. (Example: calls that do not contain an API key). WARNING:// By default, API methods do not allow unregistered calls, and each method// call must be identified by a consumer project identity.AllowUnregisteredCallsbool `json:"allowUnregisteredCalls,omitempty"`// Selector: Selects the methods to which this rule applies. Use '*' to// indicate all methods in all APIs. Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// SkipServiceControl: If true, the selected method should skip service control// and the control plane features, such as quota and billing, will not be// available. This flag is used by Google Cloud Endpoints to bypass checks for// internal methods, such as service health check methods.SkipServiceControlbool `json:"skipServiceControl,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowUnregisteredCalls") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowUnregisteredCalls") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

UsageRule: Usage configuration rules for the service.

func (UsageRule)MarshalJSON

func (sUsageRule) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp