| // Copyright 2026 Google LLC. | |
| // Use of this source code is governed by a BSD-style | |
| // license that can be found in the LICENSE file. | |
| // Code generated file. DO NOT EDIT. | |
| // 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, this | |
| // library is considered complete and is in maintenance mode. This means | |
| // that we will address critical bugs and security issues but will not add | |
| // any 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/v1" | |
| // ... | |
| // ctx := context.Background() | |
| // serviceusageService, err := serviceusage.NewService(ctx) | |
| // | |
| // In this example, Google Application Default Credentials are used for | |
| // authentication. For information on how to create and obtain Application | |
| // Default Credentials, see https://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, use [google.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 API | |
| // keys), use [google.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 OAuth | |
| // flow, use [google.golang.org/api/option.WithTokenSource]: | |
| // | |
| // config := &oauth2.Config{...} | |
| // // ... | |
| // token, err := config.Exchange(ctx, ...) | |
| // serviceusageService, err := serviceusage.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token))) | |
| // | |
| // See [google.golang.org/api/option.ClientOption] for details on options. | |
| package serviceusage // import "google.golang.org/api/serviceusage/v1" | |
| import ( | |
| "bytes" | |
| "context" | |
| "encoding/json" | |
| "errors" | |
| "fmt" | |
| "io" | |
| "log/slog" | |
| "net/http" | |
| "net/url" | |
| "strconv" | |
| "strings" | |
| "github.com/googleapis/gax-go/v2/internallog" | |
| googleapi "google.golang.org/api/googleapi" | |
| internal "google.golang.org/api/internal" | |
| gensupport "google.golang.org/api/internal/gensupport" | |
| option "google.golang.org/api/option" | |
| internaloption "google.golang.org/api/option/internaloption" | |
| htransport "google.golang.org/api/transport/http" | |
| ) | |
| // Always reference these packages, just in case the auto-generated code | |
| // below doesn't. | |
| var _ = bytes.NewBuffer | |
| var _ = strconv.Itoa | |
| var _ = fmt.Sprintf | |
| var _ = json.NewDecoder | |
| var _ = io.Copy | |
| var _ = url.Parse | |
| var _ = gensupport.MarshalJSON | |
| var _ = googleapi.Version | |
| var _ = errors.New | |
| var _ = strings.Replace | |
| var _ = context.Canceled | |
| var _ = internaloption.WithDefaultEndpoint | |
| var _ = internal.Version | |
| var _ = internallog.New | |
| const apiId = "serviceusage:v1" | |
| const apiName = "serviceusage" | |
| const apiVersion = "v1" | |
| const basePath = "https://serviceusage.googleapis.com/" | |
| const basePathTemplate = "https://serviceusage.UNIVERSE_DOMAIN/" | |
| const mtlsBasePath = "https://serviceusage.mtls.googleapis.com/" | |
| // OAuth2 scopes used by this API. | |
| 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 Account | |
| CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only" | |
| // Manage your Google API service configuration | |
| ServiceManagementScope = "https://www.googleapis.com/auth/service.management" | |
| ) | |
| // NewService creates a new Service. | |
| func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) { | |
| scopesOption := internaloption.WithDefaultScopes( | |
| "https://www.googleapis.com/auth/cloud-platform", | |
| "https://www.googleapis.com/auth/cloud-platform.read-only", | |
| "https://www.googleapis.com/auth/service.management", | |
| ) | |
| // NOTE: prepend, so we don't override user-specified scopes. | |
| opts = append([]option.ClientOption{scopesOption}, opts...) | |
| opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) | |
| opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate)) | |
| opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) | |
| opts = append(opts, internaloption.EnableNewAuthLibrary()) | |
| client, endpoint, err := htransport.NewClient(ctx, opts...) | |
| if err != nil { | |
| return nil, err | |
| } | |
| s := &Service{client: client, BasePath: basePath, logger: internaloption.GetLogger(opts)} | |
| s.Operations = NewOperationsService(s) | |
| s.Services = NewServicesService(s) | |
| if endpoint != "" { | |
| s.BasePath = endpoint | |
| } | |
| return s, nil | |
| } | |
| // New creates a new Service. 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. | |
| func New(client *http.Client) (*Service, error) { | |
| if client == nil { | |
| return nil, errors.New("client is nil") | |
| } | |
| return NewService(context.TODO(), option.WithHTTPClient(client)) | |
| } | |
| type Service struct { | |
| client *http.Client | |
| logger *slog.Logger | |
| BasePath string // API endpoint base URL | |
| UserAgent string // optional additional User-Agent fragment | |
| Operations *OperationsService | |
| Services *ServicesService | |
| } | |
| func (s *Service) userAgent() string { | |
| if s.UserAgent == "" { | |
| return googleapi.UserAgent | |
| } | |
| return googleapi.UserAgent + " " + s.UserAgent | |
| } | |
| func NewOperationsService(s *Service) *OperationsService { | |
| rs := &OperationsService{s: s} | |
| return rs | |
| } | |
| type OperationsService struct { | |
| s *Service | |
| } | |
| func NewServicesService(s *Service) *ServicesService { | |
| rs := &ServicesService{s: s} | |
| return rs | |
| } | |
| type ServicesService struct { | |
| s *Service | |
| } | |
| // AddEnableRulesMetadata: Metadata for the `AddEnableRules` method. | |
| type AddEnableRulesMetadata struct { | |
| } | |
| // AddEnableRulesResponse: The response message of `AddEnableRules` method. | |
| 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`. | |
| Parent string `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:"-"` | |
| } | |
| func (s AddEnableRulesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod AddEnableRulesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // AdminQuotaPolicy: Quota policy created by quota administrator. | |
| type AdminQuotaPolicy struct { | |
| // Container: The cloud resource container at which the quota policy is | |
| // created. The format is `{container_type}/{container_number}` | |
| Container string `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` | |
| Metric string `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` | |
| Name string `json:"name,omitempty"` | |
| // PolicyValue: The quota policy value. Can be any nonnegative integer, or -1 | |
| // (unlimited quota). | |
| PolicyValue int64 `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. | |
| Unit string `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:"-"` | |
| } | |
| func (s AdminQuotaPolicy) MarshalJSON() ([]byte, error) { | |
| type NoMethod AdminQuotaPolicy | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Analysis: A message to group the analysis information. | |
| type Analysis struct { | |
| // AnalysisResult: Output only. Analysis result of updating a policy. | |
| AnalysisResult *AnalysisResult `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. | |
| AnalysisType string `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. | |
| DisplayName string `json:"displayName,omitempty"` | |
| // Service: The names of the service that has analysis result of warnings or | |
| // blockers. Example: `services/storage.googleapis.com`. | |
| Service string `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:"-"` | |
| } | |
| func (s Analysis) MarshalJSON() ([]byte, error) { | |
| type NoMethod Analysis | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // AnalysisResult: An analysis result including blockers and warnings. | |
| 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:"-"` | |
| } | |
| func (s AnalysisResult) MarshalJSON() ([]byte, error) { | |
| type NoMethod AnalysisResult | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // AnalyzeConsumerPolicyMetadata: Metadata for the `AnalyzeConsumerPolicy` | |
| // method. | |
| type AnalyzeConsumerPolicyMetadata struct { | |
| } | |
| // AnalyzeConsumerPolicyResponse: The response of analyzing a consumer policy | |
| // update. | |
| 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:"-"` | |
| } | |
| func (s AnalyzeConsumerPolicyResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod AnalyzeConsumerPolicyResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Api: Api is a light-weight descriptor for an API Interface. Interfaces are | |
| // also described as "protocol buffer services" in some contexts, such as by | |
| // the "service" keyword in a .proto file, but they are different from API | |
| // Services, which represent a concrete implementation of an interface as | |
| // opposed to simply a description of methods and bindings. They are also | |
| // sometimes simply referred to as "APIs" in other contexts, such as the name | |
| // of this message itself. See https://cloud.google.com/apis/design/glossary | |
| // for detailed terminology. New usages of this message as an alternative to | |
| // ServiceDescriptorProto are strongly discouraged. This message does not | |
| // reliability preserve all information necessary to model the schema and | |
| // preserve semantics. Instead make use of FileDescriptorSet which preserves | |
| // the necessary information. | |
| type Api struct { | |
| // Edition: The source edition string, only valid when syntax is | |
| // SYNTAX_EDITIONS. | |
| Edition string `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. | |
| Name string `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`. | |
| Syntax string `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. | |
| Version string `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:"-"` | |
| } | |
| func (s Api) MarshalJSON() ([]byte, error) { | |
| type NoMethod Api | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Aspect: Aspect represents Generic aspect. It is used to configure an aspect | |
| // without making direct changes to service.proto | |
| type Aspect struct { | |
| // Kind: The type of this aspect configuration. | |
| Kind string `json:"kind,omitempty"` | |
| // Rules: Optional. Rules of the Configuration. | |
| Rules []*AspectRule `json:"rules,omitempty"` | |
| // Spec: Content of the configuration. The underlying schema should be defined | |
| // by Aspect owners as protobuf message under `google/api/configaspects/proto`. | |
| Spec googleapi.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:"-"` | |
| } | |
| func (s Aspect) MarshalJSON() ([]byte, error) { | |
| type NoMethod Aspect | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // AspectRule: Rule-based configuration for an aspect. | |
| type AspectRule struct { | |
| // Config: Required. Rules of the configuration. The underlying schema should | |
| // be defined by Aspect owners as protobuf message under | |
| // `google/api/configaspects/proto`. | |
| Config googleapi.RawMessage `json:"config,omitempty"` | |
| // Selector: Required. Selects the RPC methods to which this rule applies. | |
| // Refer to selector for syntax details. | |
| Selector string `json:"selector,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:"-"` | |
| } | |
| func (s AspectRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod AspectRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // AuthProvider: Configuration for an authentication provider, including | |
| // support for JSON Web Token (JWT) | |
| // (https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). | |
| 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.com | |
| Audiences string `json:"audiences,omitempty"` | |
| // AuthorizationUrl: Redirect URL if JWT token is required but not present or | |
| // is expired. Implement authorizationUrl of securityDefinitions in OpenAPI | |
| // spec. | |
| AuthorizationUrl string `json:"authorizationUrl,omitempty"` | |
| // Id: The unique identifier of the auth provider. It will be referred to by | |
| // `AuthRequirement.provider_id`. Example: "bookstore_auth". | |
| Id string `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.com | |
| Issuer string `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/certs | |
| JwksUri string `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_token | |
| JwtLocations []*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:"-"` | |
| } | |
| func (s AuthProvider) MarshalJSON() ([]byte, error) { | |
| type NoMethod AuthProvider | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // AuthRequirement: User-defined authentication requirements, including support | |
| // for JSON Web Token (JWT) | |
| // (https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). | |
| 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.com | |
| Audiences string `json:"audiences,omitempty"` | |
| // ProviderId: id from authentication provider. Example: provider_id: | |
| // bookstore_auth | |
| ProviderId string `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:"-"` | |
| } | |
| func (s AuthRequirement) MarshalJSON() ([]byte, error) { | |
| type NoMethod AuthRequirement | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Authentication: `Authentication` defines the authentication configuration | |
| // for 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/certs | |
| // issuer: https://securetoken.google.com rules: - selector: "*" requirements: | |
| // provider_id: google_calendar_auth - selector: google.calendar.Delegate | |
| // oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read | |
| 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:"-"` | |
| } | |
| func (s Authentication) MarshalJSON() ([]byte, error) { | |
| type NoMethod Authentication | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // AuthenticationRule: Authentication rules for the service. By default, if a | |
| // method has any authentication requirements, every request must include a | |
| // valid credential matching one of the requirements. It's an error to include | |
| // more than one kind of credential in a single request. If a method doesn't | |
| // have any auth requirements, request credentials will be ignored. | |
| type AuthenticationRule struct { | |
| // AllowWithoutCredential: If true, the service accepts API keys without any | |
| // other credential. This flag only applies to HTTP and gRPC requests. | |
| AllowWithoutCredential bool `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. | |
| Selector string `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:"-"` | |
| } | |
| func (s AuthenticationRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod AuthenticationRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Backend: `Backend` defines the backend configuration for a service. | |
| 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:"-"` | |
| } | |
| func (s Backend) MarshalJSON() ([]byte, error) { | |
| type NoMethod Backend | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BackendRule: A backend rule provides configuration for an individual API | |
| // element. | |
| 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. | |
| Address string `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. | |
| Deadline float64 `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. | |
| DisableAuth bool `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. | |
| JwtAudience string `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". | |
| LoadBalancingPolicy string `json:"loadBalancingPolicy,omitempty"` | |
| // MinDeadline: Deprecated, do not use. | |
| MinDeadline float64 `json:"minDeadline,omitempty"` | |
| // OperationDeadline: The number of seconds to wait for the completion of a | |
| // long running operation. The default is no deadline. | |
| OperationDeadline float64 `json:"operationDeadline,omitempty"` | |
| // OverridesByRequestProtocol: The map between request protocol and the backend | |
| // address. | |
| OverridesByRequestProtocol map[string]BackendRule `json:"overridesByRequestProtocol,omitempty"` | |
| // PathTranslation: Path translation specifies how to combine the backend | |
| // address with the request path in order to produce the appropriate forwarding | |
| // URL for the request. See PathTranslation for more details. | |
| // | |
| // 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=EST | |
| PathTranslation string `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. | |
| Protocol string `json:"protocol,omitempty"` | |
| // Selector: Selects the methods to which this rule applies. Refer to selector | |
| // for syntax details. | |
| Selector string `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:"-"` | |
| } | |
| func (s BackendRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod BackendRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| func (s *BackendRule) UnmarshalJSON(data []byte) error { | |
| type NoMethod BackendRule | |
| var s1 struct { | |
| Deadline gensupport.JSONFloat64 `json:"deadline"` | |
| MinDeadline gensupport.JSONFloat64 `json:"minDeadline"` | |
| OperationDeadline gensupport.JSONFloat64 `json:"operationDeadline"` | |
| *NoMethod | |
| } | |
| s1.NoMethod = (*NoMethod)(s) | |
| if err := json.Unmarshal(data, &s1); err != nil { | |
| return err | |
| } | |
| s.Deadline = float64(s1.Deadline) | |
| s.MinDeadline = float64(s1.MinDeadline) | |
| s.OperationDeadline = float64(s1.OperationDeadline) | |
| return nil | |
| } | |
| // BatchCreateAdminOverridesResponse: Response message for | |
| // BatchCreateAdminOverrides | |
| 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:"-"` | |
| } | |
| func (s BatchCreateAdminOverridesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod BatchCreateAdminOverridesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BatchCreateConsumerOverridesResponse: Response message for | |
| // BatchCreateConsumerOverrides | |
| 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:"-"` | |
| } | |
| func (s BatchCreateConsumerOverridesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod BatchCreateConsumerOverridesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BatchEnableServicesRequest: Request message for the `BatchEnableServices` | |
| // method. | |
| 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. 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:"-"` | |
| } | |
| func (s BatchEnableServicesRequest) MarshalJSON() ([]byte, error) { | |
| type NoMethod BatchEnableServicesRequest | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BatchEnableServicesResponse: Response message for the `BatchEnableServices` | |
| // method. This response message is assigned to the `response` field of the | |
| // returned Operation when that operation is done. | |
| 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:"-"` | |
| } | |
| func (s BatchEnableServicesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod BatchEnableServicesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BatchGetServicesResponse: Response message for the `BatchGetServices` | |
| // method. | |
| type BatchGetServicesResponse struct { | |
| // Services: The requested Service states. | |
| Services []*GoogleApiServiceusageV1Service `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. "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:"-"` | |
| } | |
| func (s BatchGetServicesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod BatchGetServicesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BatchingConfigProto: `BatchingConfigProto` defines the batching | |
| // configuration for an API method. | |
| 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:"-"` | |
| } | |
| func (s BatchingConfigProto) MarshalJSON() ([]byte, error) { | |
| type NoMethod BatchingConfigProto | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BatchingDescriptorProto: `BatchingDescriptorProto` specifies the fields of | |
| // the request message to be used for batching, and, optionally, the fields of | |
| // the response message to be used for demultiplexing. | |
| type BatchingDescriptorProto struct { | |
| // BatchedField: The repeated field in the request message to be aggregated by | |
| // batching. | |
| BatchedField string `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. | |
| SubresponseField string `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:"-"` | |
| } | |
| func (s BatchingDescriptorProto) MarshalJSON() ([]byte, error) { | |
| type NoMethod BatchingDescriptorProto | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BatchingSettingsProto: `BatchingSettingsProto` specifies a set of batching | |
| // thresholds, each of which acts as a trigger to send a batch of messages as a | |
| // request. At least one threshold must be positive nonzero. | |
| type BatchingSettingsProto struct { | |
| // DelayThreshold: The duration after which a batch should be sent, starting | |
| // from the addition of the first message to that batch. | |
| DelayThreshold string `json:"delayThreshold,omitempty"` | |
| // ElementCountLimit: The maximum number of elements collected in a batch that | |
| // could be accepted by server. | |
| ElementCountLimit int64 `json:"elementCountLimit,omitempty"` | |
| // ElementCountThreshold: The number of elements of a field collected into a | |
| // batch which, if exceeded, causes the batch to be sent. | |
| ElementCountThreshold int64 `json:"elementCountThreshold,omitempty"` | |
| // FlowControlByteLimit: The maximum size of data allowed by flow control. | |
| FlowControlByteLimit int64 `json:"flowControlByteLimit,omitempty"` | |
| // FlowControlElementLimit: The maximum number of elements allowed by flow | |
| // control. | |
| FlowControlElementLimit int64 `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. | |
| FlowControlLimitExceededBehavior string `json:"flowControlLimitExceededBehavior,omitempty"` | |
| // RequestByteLimit: The maximum size of the request that could be accepted by | |
| // server. | |
| RequestByteLimit int64 `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. | |
| RequestByteThreshold int64 `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:"-"` | |
| } | |
| func (s BatchingSettingsProto) MarshalJSON() ([]byte, error) { | |
| type NoMethod BatchingSettingsProto | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Billing: Billing related configuration of the service. The following example | |
| // shows how to configure monitored resources and metrics for billing, | |
| // `consumer_destinations` is the only supported destination and the monitored | |
| // resources need at least one label key `cloud.googleapis.com/location` to | |
| // indicate the location of the billing usage, using different monitored | |
| // resources between monitoring and billing is recommended so they can be | |
| // evolved independently: monitored_resources: - type: | |
| // library.googleapis.com/billing_branch labels: - key: | |
| // cloud.googleapis.com/location description: | Predefined label to support | |
| // billing location restriction. - key: city description: | Custom label to | |
| // define the city where the library branch is located in. - key: name | |
| // description: Custom label to define the name of the library branch. metrics: | |
| // - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA | |
| // value_type: INT64 unit: "1" billing: consumer_destinations: - | |
| // monitored_resource: library.googleapis.com/billing_branch metrics: - | |
| // library.googleapis.com/book/borrowed_count | |
| 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:"-"` | |
| } | |
| func (s Billing) MarshalJSON() ([]byte, error) { | |
| type NoMethod Billing | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // BillingDestination: Configuration of a specific billing destination | |
| // (Currently only support bill against consumer project). | |
| 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. | |
| MonitoredResource string `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:"-"` | |
| } | |
| func (s BillingDestination) MarshalJSON() ([]byte, error) { | |
| type NoMethod BillingDestination | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // CancelOperationRequest: The request message for Operations.CancelOperation. | |
| type CancelOperationRequest struct { | |
| } | |
| // ClientLibrarySettings: Details about how and where to publish client | |
| // libraries. | |
| 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. | |
| LaunchStage string `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. | |
| RestNumericEnums bool `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". | |
| Version string `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:"-"` | |
| } | |
| func (s ClientLibrarySettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod ClientLibrarySettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // CommonLanguageSettings: Required information for every language. | |
| 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/latest | |
| ReferenceDocsUri string `json:"referenceDocsUri,omitempty"` | |
| // SelectiveGapicGeneration: Configuration for which RPCs should be generated | |
| // in the GAPIC client. Note: This field should not be used in most cases. | |
| 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:"-"` | |
| } | |
| func (s CommonLanguageSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod CommonLanguageSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ConsumerPolicy: Consumer Policy is a set of rules that define what services | |
| // or service groups can be used for a cloud resource hierarchy. | |
| type ConsumerPolicy struct { | |
| // CreateTime: Output only. The time the policy was created. For singleton | |
| // policies, this is the first touch of the policy. | |
| CreateTime string `json:"createTime,omitempty"` | |
| // EnableRules: Enable rules define usable services and groups. There can | |
| // currently be at most one `EnableRule`. This restriction will be lifted in | |
| // later releases. | |
| EnableRules []*EnableRule `json:"enableRules,omitempty"` | |
| // Etag: An opaque tag indicating the current version of the policy, used for | |
| // concurrency control. | |
| Etag string `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`. | |
| Name string `json:"name,omitempty"` | |
| // UpdateTime: Output only. The time the policy was last updated. | |
| UpdateTime string `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:"-"` | |
| } | |
| func (s ConsumerPolicy) MarshalJSON() ([]byte, error) { | |
| type NoMethod ConsumerPolicy | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ContentSecurity: ContentSecurity defines the content security related fields | |
| // of a MCP policy. | |
| 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:"-"` | |
| } | |
| func (s ContentSecurity) MarshalJSON() ([]byte, error) { | |
| type NoMethod ContentSecurity | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ContentSecurityPolicy: Content Security Policy contains the content security | |
| // related policy of a resource. | |
| 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. | |
| Name string `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:"-"` | |
| } | |
| func (s ContentSecurityPolicy) MarshalJSON() ([]byte, error) { | |
| type NoMethod ContentSecurityPolicy | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ContentSecurityProvider: ContentSecurityProvider contains the name of | |
| // content security provider. | |
| 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. | |
| Name string `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:"-"` | |
| } | |
| func (s ContentSecurityProvider) MarshalJSON() ([]byte, error) { | |
| type NoMethod ContentSecurityProvider | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // 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 the | |
| // API request `google.rpc.context.ProjectContext` and | |
| // `google.rpc.context.OriginContext`. Available context types are defined in | |
| // package `google.rpc.context`. This also provides mechanism to allowlist any | |
| // protobuf message extension that can be sent in grpc metadata using | |
| // “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list | |
| // any service specific protobuf types that can appear in grpc metadata as | |
| // follows in your yaml file: Example: context: rules: - selector: | |
| // "google.example.library.v1.LibraryService.CreateBook" | |
| // allowed_request_extensions: - google.foo.v1.NewExtension | |
| // allowed_response_extensions: - google.foo.v1.NewExtension You can also | |
| // specify extension ID instead of fully qualified extension name here. | |
| 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:"-"` | |
| } | |
| func (s Context) MarshalJSON() ([]byte, error) { | |
| type NoMethod Context | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ContextRule: A context rule provides information about the context for an | |
| // individual API element. | |
| 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. | |
| Selector string `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:"-"` | |
| } | |
| func (s ContextRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod ContextRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Control: Selects and configures the service controller used by the service. | |
| // Example: control: environment: servicecontrol.googleapis.com | |
| type Control struct { | |
| // Environment: The service controller environment to use. If empty, no control | |
| // plane features (like quota and billing) will be enabled. The recommended | |
| // value for most services is servicecontrol.googleapis.com. | |
| Environment string `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:"-"` | |
| } | |
| func (s Control) MarshalJSON() ([]byte, error) { | |
| type NoMethod Control | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // CppSettings: Settings for C++ client libraries. | |
| 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:"-"` | |
| } | |
| func (s CppSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod CppSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // CreateAdminQuotaPolicyMetadata: Metadata message that provides information | |
| // such as progress, partial failures, and similar information on each | |
| // GetOperation call of LRO returned by CreateAdminQuotaPolicy. | |
| type CreateAdminQuotaPolicyMetadata struct { | |
| } | |
| // CustomError: Customize service error responses. For example, list any | |
| // service specific protobuf types that can appear in error detail lists of | |
| // error responses. Example: custom_error: types: - google.foo.v1.CustomError - | |
| // google.foo.v1.AnotherError | |
| 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:"-"` | |
| } | |
| func (s CustomError) MarshalJSON() ([]byte, error) { | |
| type NoMethod CustomError | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // CustomErrorRule: A custom error rule. | |
| 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. | |
| IsErrorType bool `json:"isErrorType,omitempty"` | |
| // Selector: Selects messages to which this rule applies. Refer to selector for | |
| // syntax details. | |
| Selector string `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:"-"` | |
| } | |
| func (s CustomErrorRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod CustomErrorRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // CustomHttpPattern: A custom pattern is used for defining custom HTTP verb. | |
| type CustomHttpPattern struct { | |
| // Kind: The name of this custom HTTP verb. | |
| Kind string `json:"kind,omitempty"` | |
| // Path: The path matched by this custom verb. | |
| Path string `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:"-"` | |
| } | |
| func (s CustomHttpPattern) MarshalJSON() ([]byte, error) { | |
| type NoMethod CustomHttpPattern | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // DeleteAdminQuotaPolicyMetadata: Metadata message that provides information | |
| // such as progress, partial failures, and similar information on each | |
| // GetOperation call of LRO returned by DeleteAdminQuotaPolicy. | |
| type DeleteAdminQuotaPolicyMetadata struct { | |
| } | |
| // DisableServiceRequest: Request message for the `DisableService` method. | |
| type DisableServiceRequest struct { | |
| // CheckIfServiceHasUsage: Defines the behavior for checking service usage when | |
| // disabling a service. | |
| // | |
| // Possible values: | |
| // "CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED" - When unset, the default | |
| // behavior is used, which is SKIP. | |
| // "SKIP" - If set, skip checking service usage when disabling a service. | |
| // "CHECK" - If set, service usage is checked when disabling the service. If | |
| // a service, or its dependents, has usage in the last 30 days, the request | |
| // returns a FAILED_PRECONDITION error. | |
| CheckIfServiceHasUsage string `json:"checkIfServiceHasUsage,omitempty"` | |
| // DisableDependentServices: Indicates if services that are enabled and which | |
| // depend on this service should also be disabled. If not set, an error will be | |
| // generated if any enabled services depend on the service to be disabled. When | |
| // set, the service, and any enabled services that depend on it, will be | |
| // disabled together. | |
| DisableDependentServices bool `json:"disableDependentServices,omitempty"` | |
| // ForceSendFields is a list of field names (e.g. "CheckIfServiceHasUsage") 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. "CheckIfServiceHasUsage") 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:"-"` | |
| } | |
| func (s DisableServiceRequest) MarshalJSON() ([]byte, error) { | |
| type NoMethod DisableServiceRequest | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // DisableServiceResponse: Response message for the `DisableService` method. | |
| // This response message is assigned to the `response` field of the returned | |
| // Operation when that operation is done. | |
| 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:"-"` | |
| } | |
| func (s DisableServiceResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod DisableServiceResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Documentation: `Documentation` provides the information for describing a | |
| // service. Example: documentation: summary: > The Google Calendar API gives | |
| // access to most calendar features. pages: - name: Overview content: (== | |
| // include google/foo/overview.md ==) - name: Tutorial content: (== include | |
| // google/foo/tutorial.md ==) subpages: - name: Java content: (== include | |
| // google/foo/tutorial_java.md ==) rules: - selector: | |
| // google.calendar.Calendar.Get description: > ... - selector: | |
| // google.calendar.Calendar.Put description: > ... Documentation is provided in | |
| // markdown syntax. In addition to standard markdown features, definition | |
| // lists, tables and fenced code blocks are supported. Section headers can be | |
| // provided and are interpreted relative to the section nesting of the context | |
| // where a documentation fragment is embedded. Documentation from the IDL is | |
| // merged with documentation defined via the config at normalization time, | |
| // where documentation provided by config rules overrides IDL provided. A | |
| // number of constructs specific to the API platform are supported in | |
| // documentation text. In order to reference a proto element, the following | |
| // notation can be used: [fully.qualified.proto.name][] To override the display | |
| // text used for the link, this can be used: [display | |
| // text][fully.qualified.proto.name] Text can be excluded from doc using the | |
| // following notation: (-- internal comment --) A few directives are available | |
| // in documentation. Note that directives must appear on a single line to be | |
| // properly identified. The `include` directive includes a markdown file from | |
| // an 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 the | |
| // operations in a collection: (== resource_for v1.shelves.books ==) The | |
| // directive `suppress_warning` does not directly affect documentation and is | |
| // documented together with service config validation. | |
| 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. | |
| AdditionalIamInfo string `json:"additionalIamInfo,omitempty"` | |
| // DocumentationRootUrl: The URL to the root of documentation. | |
| DocumentationRootUrl string `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. | |
| Overview string `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_libraries | |
| SectionOverrides []*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. | |
| ServiceRootUrl string `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`. | |
| Summary string `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:"-"` | |
| } | |
| func (s Documentation) MarshalJSON() ([]byte, error) { | |
| type NoMethod Documentation | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // DocumentationRule: A documentation rule provides information about | |
| // individual API elements. | |
| type DocumentationRule struct { | |
| // DeprecationDescription: Deprecation description of the selected element(s). | |
| // It can be provided if an element is marked as `deprecated`. | |
| DeprecationDescription string `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. | |
| Description string `json:"description,omitempty"` | |
| // DisableReplacementWords: String of comma or space separated case-sensitive | |
| // words for which method/field name replacement will be disabled. | |
| DisableReplacementWords string `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. | |
| Selector string `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:"-"` | |
| } | |
| func (s DocumentationRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod DocumentationRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // DotnetSettings: Settings for Dotnet client libraries. | |
| 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 collision | |
| ForcedNamespaceAliases []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:"-"` | |
| } | |
| func (s DotnetSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod DotnetSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Empty: A generic empty message that you can re-use to avoid defining | |
| // duplicated empty messages in your APIs. A typical example is to use it as | |
| // the request or the response type of an API method. For instance: service Foo | |
| // { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } | |
| type Empty struct { | |
| // ServerResponse contains the HTTP response code and headers from the server. | |
| googleapi.ServerResponse `json:"-"` | |
| } | |
| // EnableFailure: Provides error messages for the failing services. | |
| type EnableFailure struct { | |
| // ErrorMessage: An error message describing why the service could not be | |
| // enabled. | |
| ErrorMessage string `json:"errorMessage,omitempty"` | |
| // ServiceId: The service id of a service that could not be enabled. | |
| ServiceId string `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:"-"` | |
| } | |
| func (s EnableFailure) MarshalJSON() ([]byte, error) { | |
| type NoMethod EnableFailure | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // EnableRule: The consumer policy rule that defines enabled services and | |
| // catalogs. | |
| type EnableRule struct { | |
| // Catalogs: The names of the catalogs that are enabled. Example: | |
| // `catalogs/default-cloud-services`. | |
| Catalogs []string `json:"catalogs,omitempty"` | |
| // Services: The names of the services that are enabled. Example: | |
| // `services/storage.googleapis.com`. | |
| Services []string `json:"services,omitempty"` | |
| // Values: Deprecated: Use the `services` field instead. 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. "Catalogs") 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. "Catalogs") 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:"-"` | |
| } | |
| func (s EnableRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod EnableRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // EnableServiceRequest: Request message for the `EnableService` method. | |
| type EnableServiceRequest struct { | |
| } | |
| // EnableServiceResponse: Response message for the `EnableService` method. This | |
| // response message is assigned to the `response` field of the returned | |
| // Operation when that operation is done. | |
| 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:"-"` | |
| } | |
| func (s EnableServiceResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod EnableServiceResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Endpoint: `Endpoint` describes a network address of a service that serves a | |
| // set of APIs. It is commonly known as a service endpoint. A service may | |
| // expose any number of service endpoints, and all service endpoints share the | |
| // same service definition, such as quota limits and monitoring metrics. | |
| // Example: type: google.api.Service name: library-example.googleapis.com | |
| // endpoints: # Declares network address | |
| // `https://library-example.googleapis.com` # for service | |
| // `library-example.googleapis.com`. The `https` scheme # is implicit for all | |
| // service 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 calls | |
| // to be passed to the API frontend, for it # to decide whether the subsequent | |
| // cross-origin request is allowed # to proceed. allow_cors: true | |
| 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. | |
| AllowCors bool `json:"allowCors,omitempty"` | |
| // Name: The canonical name of this endpoint. | |
| Name string `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". | |
| Target string `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:"-"` | |
| } | |
| func (s Endpoint) MarshalJSON() ([]byte, error) { | |
| type NoMethod Endpoint | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Enum: Enum type definition. New usages of this message as an alternative to | |
| // EnumDescriptorProto are strongly discouraged. This message does not | |
| // reliability preserve all information necessary to model the schema and | |
| // preserve semantics. Instead make use of FileDescriptorSet which preserves | |
| // the necessary information. | |
| type Enum struct { | |
| // Edition: The source edition string, only valid when syntax is | |
| // SYNTAX_EDITIONS. | |
| Edition string `json:"edition,omitempty"` | |
| // Enumvalue: Enum value definitions. | |
| Enumvalue []*EnumValue `json:"enumvalue,omitempty"` | |
| // Name: Enum type name. | |
| Name string `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`. | |
| Syntax string `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:"-"` | |
| } | |
| func (s Enum) MarshalJSON() ([]byte, error) { | |
| type NoMethod Enum | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // EnumValue: Enum value definition. New usages of this message as an | |
| // alternative to EnumValueDescriptorProto are strongly discouraged. This | |
| // message does not reliability preserve all information necessary to model the | |
| // schema and preserve semantics. Instead make use of FileDescriptorSet which | |
| // preserves the necessary information. | |
| type EnumValue struct { | |
| // Name: Enum value name. | |
| Name string `json:"name,omitempty"` | |
| // Number: Enum value number. | |
| Number int64 `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:"-"` | |
| } | |
| func (s EnumValue) MarshalJSON() ([]byte, error) { | |
| type NoMethod EnumValue | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ExperimentalFeatures: Experimental features to be included during client | |
| // library generation. These fields will be deprecated once the feature | |
| // graduates and is enabled by default. | |
| 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. | |
| ProtobufPythonicTypesEnabled bool `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. | |
| RestAsyncIoEnabled bool `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`. | |
| UnversionedPackageDisabled bool `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. 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. "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:"-"` | |
| } | |
| func (s ExperimentalFeatures) MarshalJSON() ([]byte, error) { | |
| type NoMethod ExperimentalFeatures | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Field: A single field of a message type. New usages of this message as an | |
| // alternative to FieldDescriptorProto are strongly discouraged. This message | |
| // does not reliability preserve all information necessary to model the schema | |
| // and preserve semantics. Instead make use of FileDescriptorSet which | |
| // preserves the necessary information. | |
| 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. | |
| Cardinality string `json:"cardinality,omitempty"` | |
| // DefaultValue: The string value of the default value of this field. Proto2 | |
| // syntax only. | |
| DefaultValue string `json:"defaultValue,omitempty"` | |
| // JsonName: The field JSON name. | |
| JsonName string `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. | |
| Kind string `json:"kind,omitempty"` | |
| // Name: The field name. | |
| Name string `json:"name,omitempty"` | |
| // Number: The field number. | |
| Number int64 `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. | |
| OneofIndex int64 `json:"oneofIndex,omitempty"` | |
| // Options: The protocol buffer options. | |
| Options []*Option `json:"options,omitempty"` | |
| // Packed: Whether to use alternative packed wire representation. | |
| Packed bool `json:"packed,omitempty"` | |
| // TypeUrl: The field type URL, without the scheme, for message or enumeration | |
| // types. Example: "type.googleapis.com/google.protobuf.Timestamp". | |
| TypeUrl string `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:"-"` | |
| } | |
| func (s Field) MarshalJSON() ([]byte, error) { | |
| type NoMethod Field | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // FieldPolicy: Google API Policy Annotation This message defines a simple API | |
| // policy annotation that can be used to annotate API request and response | |
| // message fields with applicable policies. One field may have multiple | |
| // applicable policies that must all be satisfied before a request can be | |
| // processed. This policy annotation is used to generate the overall policy | |
| // that will be used for automatic runtime policy enforcement and documentation | |
| // generation. | |
| 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". | |
| ResourcePermission string `json:"resourcePermission,omitempty"` | |
| // ResourceType: Specifies the resource type for the resource referred to by | |
| // the field. | |
| ResourceType string `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". | |
| Selector string `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:"-"` | |
| } | |
| func (s FieldPolicy) MarshalJSON() ([]byte, error) { | |
| type NoMethod FieldPolicy | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GetServiceIdentityMetadata: Metadata for the `GetServiceIdentity` method. | |
| type GetServiceIdentityMetadata struct { | |
| } | |
| // GetServiceIdentityResponse: Response message for getting service identity. | |
| 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. | |
| State string `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:"-"` | |
| } | |
| func (s GetServiceIdentityResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod GetServiceIdentityResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoSettings: Settings for Go client libraries. | |
| 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: TopicAdmin | |
| 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:"-"` | |
| } | |
| func (s GoSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiService: `Service` is the root object of Google API service | |
| // configuration (service config). It describes the basic information about a | |
| // logical service, such as the service name and the user-facing title, and | |
| // delegates other aspects to sub-sections. Each sub-section is either a proto | |
| // message or a repeated proto message that configures a specific aspect, such | |
| // as auth. For more information, see each proto message definition. Example: | |
| // type: google.api.Service name: calendar.googleapis.com title: Google | |
| // Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - | |
| // selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - | |
| // selector: "google.calendar.v3.*" address: calendar.example.com | |
| // authentication: 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 | |
| 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`. | |
| ConfigVersion int64 `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.SomeEnum | |
| Enums []*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. | |
| Id string `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. | |
| Name string `json:"name,omitempty"` | |
| // ProducerProjectId: The Google project that owns this service. | |
| ProducerProjectId string `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. | |
| Title string `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.Int32 | |
| Types []*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:"-"` | |
| } | |
| func (s GoogleApiService) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiService | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV1OperationMetadata: The operation metadata returned | |
| // for the batchend services operation. | |
| 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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV1OperationMetadata) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV1OperationMetadata | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV1Service: A service that is available for use by the | |
| // consumer. | |
| 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.com | |
| Name string `json:"name,omitempty"` | |
| // Parent: The resource name of the consumer. A valid name would be: - | |
| // projects/123 | |
| Parent string `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. | |
| State string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV1Service) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV1Service | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV1ServiceConfig: The configuration of the service. | |
| 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`. | |
| Name string `json:"name,omitempty"` | |
| // Quota: Quota configuration. | |
| Quota *Quota `json:"quota,omitempty"` | |
| // Title: The product title for this service. | |
| Title string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV1ServiceConfig) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV1ServiceConfig | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV1beta1GetServiceIdentityResponse: Response message for | |
| // getting service identity. | |
| 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. | |
| State string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV1beta1GetServiceIdentityResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV1beta1GetServiceIdentityResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV1beta1ServiceIdentity: Service identity for a service. | |
| // This is the identity that service producer should use to access consumer | |
| // resources. | |
| type GoogleApiServiceusageV1beta1ServiceIdentity struct { | |
| // Email: The email address of the service account that a service producer | |
| // would use to access consumer resources. | |
| Email string `json:"email,omitempty"` | |
| // UniqueId: The unique and stable id of the service account. | |
| // https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount | |
| UniqueId string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV1beta1ServiceIdentity) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV1beta1ServiceIdentity | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2alphaAnalysis: A message to group the analysis | |
| // information. | |
| type GoogleApiServiceusageV2alphaAnalysis struct { | |
| // AnalysisResult: Output only. Analysis result of updating a policy. | |
| AnalysisResult *GoogleApiServiceusageV2alphaAnalysisResult `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. | |
| // "ANALYSIS_TYPE_RESOURCE_EXISTENCE" - The analysis of service resource | |
| // existence. | |
| AnalysisType string `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. | |
| DisplayName string `json:"displayName,omitempty"` | |
| // Service: The names of the service that has analysis result of warnings or | |
| // blockers. Example: `services/storage.googleapis.com`. | |
| Service string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2alphaAnalysis) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2alphaAnalysis | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2alphaAnalysisResult: An analysis result including | |
| // blockers and warnings. | |
| type GoogleApiServiceusageV2alphaAnalysisResult struct { | |
| // Blockers: Blocking information that would prevent the policy changes at | |
| // runtime. | |
| Blockers []*GoogleApiServiceusageV2alphaImpact `json:"blockers,omitempty"` | |
| // Warnings: Warning information indicating that the policy changes might be | |
| // unsafe, but will not block the changes at runtime. | |
| Warnings []*GoogleApiServiceusageV2alphaImpact `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2alphaAnalysisResult) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2alphaAnalysisResult | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyMetadata: Metadata for the | |
| // `AnalyzeConsumerPolicy` method. | |
| type GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyMetadata struct { | |
| } | |
| // GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse: The response of | |
| // analyzing a consumer policy update. | |
| type GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse 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 []*GoogleApiServiceusageV2alphaAnalysis `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2alphaAnalyzeConsumerPolicyResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2alphaConsumerPolicy: Consumer Policy is a set of | |
| // rules that define what services or service groups can be used for a cloud | |
| // resource hierarchy. | |
| 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. | |
| CreateTime string `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. | |
| Etag string `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`. | |
| Name string `json:"name,omitempty"` | |
| // UpdateTime: Output only. The time the policy was last updated. | |
| UpdateTime string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2alphaConsumerPolicy) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2alphaConsumerPolicy | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2alphaEnableRule: The consumer policy rule that | |
| // defines enabled services, groups, and categories. | |
| 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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2alphaEnableRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2alphaEnableRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2alphaImpact: A message to group impacts of updating a | |
| // policy. | |
| type GoogleApiServiceusageV2alphaImpact struct { | |
| // Detail: Output only. User friendly impact detail in a free form message. | |
| Detail string `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_EXISTENCE | |
| ImpactType string `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. | |
| Parent string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2alphaImpact) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2alphaImpact | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: Metadata for the | |
| // `UpdateConsumerPolicy` method. | |
| type GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata struct { | |
| } | |
| // GoogleApiServiceusageV2betaAnalysis: A message to group the analysis | |
| // information. | |
| 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. | |
| AnalysisType string `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. | |
| DisplayName string `json:"displayName,omitempty"` | |
| // Service: The names of the service that has analysis result of warnings or | |
| // blockers. Example: `services/storage.googleapis.com`. | |
| Service string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaAnalysis) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaAnalysis | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaAnalysisResult: An analysis result including | |
| // blockers and warnings. | |
| 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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaAnalysisResult) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaAnalysisResult | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata: Metadata for the | |
| // `AnalyzeConsumerPolicy` method. | |
| type GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata struct { | |
| } | |
| // GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse: The response of | |
| // analyzing a consumer policy update. | |
| 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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaConsumerPolicy: Consumer Policy is a set of rules | |
| // that define what services or service groups can be used for a cloud resource | |
| // hierarchy. | |
| type GoogleApiServiceusageV2betaConsumerPolicy struct { | |
| // CreateTime: Output only. The time the policy was created. For singleton | |
| // policies, this is the first touch of the policy. | |
| CreateTime string `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. | |
| Etag string `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`. | |
| Name string `json:"name,omitempty"` | |
| // UpdateTime: Output only. The time the policy was last updated. | |
| UpdateTime string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaConsumerPolicy) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaConsumerPolicy | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaEnableRule: The consumer policy rule that defines | |
| // enabled services, groups, and categories. | |
| type GoogleApiServiceusageV2betaEnableRule struct { | |
| // Catalogs: The names of the catalogs that are enabled. Example: | |
| // `catalogs/default-cloud-services`. | |
| Catalogs []string `json:"catalogs,omitempty"` | |
| // 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. "Catalogs") 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. "Catalogs") 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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaEnableRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaEnableRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaImpact: A message to group impacts of updating a | |
| // policy. | |
| type GoogleApiServiceusageV2betaImpact struct { | |
| // Detail: Output only. User friendly impact detail in a free form message. | |
| Detail string `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_DEPENDENCY | |
| ImpactType string `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}.` | |
| MissingDependency string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaImpact) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaImpact | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaMcpEnableRule: McpEnableRule contains MCP | |
| // enablement related rules. | |
| type GoogleApiServiceusageV2betaMcpEnableRule struct { | |
| // McpServices: List of enabled MCP services. | |
| McpServices []*GoogleApiServiceusageV2betaMcpService `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaMcpEnableRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaMcpEnableRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaMcpPolicy: MCP Consumer Policy is a set of rules | |
| // that define MCP related policy for a cloud resource hierarchy. | |
| type GoogleApiServiceusageV2betaMcpPolicy 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. | |
| CreateTime string `json:"createTime,omitempty"` | |
| // Etag: An opaque tag indicating the current version of the policy, used for | |
| // concurrency control. | |
| Etag string `json:"etag,omitempty"` | |
| // McpEnableRules: McpEnableRules contains MCP enablement related rules. | |
| McpEnableRules []*GoogleApiServiceusageV2betaMcpEnableRule `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`. | |
| Name string `json:"name,omitempty"` | |
| // UpdateTime: Output only. The time the policy was last updated. | |
| UpdateTime string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaMcpPolicy) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaMcpPolicy | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaMcpService: McpService contains the service names | |
| // that are enabled for MCP. | |
| type GoogleApiServiceusageV2betaMcpService struct { | |
| // Service: The names of the services that are enabled for MCP. Example: | |
| // `services/library-example.googleapis.com` | |
| Service string `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:"-"` | |
| } | |
| func (s GoogleApiServiceusageV2betaMcpService) MarshalJSON() ([]byte, error) { | |
| type NoMethod GoogleApiServiceusageV2betaMcpService | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata: Metadata for the | |
| // `UpdateConsumerPolicy` method. | |
| type GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata struct { | |
| } | |
| // GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata: Metadata for the | |
| // `UpdateMcpPolicy` method. | |
| type GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata struct { | |
| } | |
| // Http: Defines the HTTP configuration for an API service. It contains a list | |
| // of HttpRule, each specifying the mapping of an RPC method to one or more | |
| // HTTP REST API methods. | |
| 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 | |
| // decode RFC 6570 reserved characters in multi segment matches. | |
| FullyDecodeReservedExpansion bool `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. 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. "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:"-"` | |
| } | |
| func (s Http) MarshalJSON() ([]byte, error) { | |
| type NoMethod Http | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // HttpRule: gRPC Transcoding gRPC Transcoding is a feature for mapping between | |
| // a gRPC method and one or more HTTP REST endpoints. It allows developers to | |
| // build a single API service that supports both gRPC APIs and REST APIs. Many | |
| // systems, 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 it | |
| // for large scale production services. `HttpRule` defines the schema of the | |
| // gRPC/REST mapping. The mapping specifies how different portions of the gRPC | |
| // request message are mapped to the URL path, URL query parameters, and HTTP | |
| // request body. It also controls how the gRPC response message is mapped to | |
| // the HTTP response body. `HttpRule` is typically specified as an | |
| // `google.api.http` annotation on the gRPC method. Each mapping specifies a | |
| // URL path template and an HTTP method. The path template may refer to one or | |
| // more fields in the gRPC request message, as long as each field is a | |
| // non-repeated field with a primitive (non-message) type. The path template | |
| // controls 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 enables | |
| // an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - | |
| // gRPC: `GetMessage(name: "messages/123456")` Any fields in the request | |
| // message which are not bound by the path template automatically become HTTP | |
| // query parameters if there is no HTTP request body. For example: service | |
| // Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option | |
| // (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message | |
| // GetMessageRequest { message SubMessage { string subfield = 1; } string | |
| // message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL | |
| // query parameter `revision`. SubMessage sub = 3; // Mapped to URL query | |
| // parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as | |
| // below: - 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 have | |
| // a primitive type or a repeated primitive type or a non-repeated message | |
| // type. In the case of a repeated type, the parameter can be repeated in the | |
| // URL as `...?param=A¶m=B`. In the case of a message type, each field of | |
| // the 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 the | |
| // message resource collection: service Messaging { rpc | |
| // UpdateMessage(UpdateMessageRequest) returns (Message) { option | |
| // (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; | |
| // } } message UpdateMessageRequest { string message_id = 1; // mapped to the | |
| // URL Message message = 2; // mapped to the body } The following HTTP JSON to | |
| // RPC mapping is enabled, where the representation of the JSON in the request | |
| // body 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 the | |
| // body mapping to define that every field not bound by the path template | |
| // should be mapped to the request body. This enables the following alternative | |
| // definition of the update method: service Messaging { rpc | |
| // UpdateMessage(Message) returns (Message) { option (google.api.http) = { | |
| // patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string | |
| // message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is | |
| // enabled: - 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 all | |
| // fields not bound by the path end in the body. This makes this option more | |
| // rarely used in practice when defining REST APIs. The common usage of `*` is | |
| // in custom methods which don't use the URL at all for transferring data. It | |
| // is possible to define multiple HTTP methods for one RPC by using the | |
| // `additional_bindings` option. Example: service Messaging { rpc | |
| // GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = | |
| // { get: "/v1/messages/{message_id}" additional_bindings { get: | |
| // "/v1/users/{user_id}/messages/{message_id}" } }; } } message | |
| // GetMessageRequest { string message_id = 1; string user_id = 2; } This | |
| // enables 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 classified | |
| // into three categories: - Fields referred by the path template. They are | |
| // passed via the URL path. - Fields referred by the HttpRule.body. They are | |
| // passed via the HTTP request body. - All other fields are passed via the URL | |
| // query parameters, and the parameter name is the field path in the request | |
| // message. A repeated field can be represented as multiple query parameters | |
| // under the same name. 2. If HttpRule.body is "*", there is no URL query | |
| // parameter, all fields are passed via URL path and HTTP request body. 3. If | |
| // HttpRule.body is omitted, there is no HTTP request body, all fields are | |
| // passed 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 URL | |
| // path 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 by | |
| // its template. A variable template must not contain other variables. If a | |
| // variable matches a single path segment, its template may be omitted, e.g. | |
| // `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal | |
| // text in the URL path. If the `LITERAL` contains any reserved character, such | |
| // characters should be percent-encoded before the matching. If a variable | |
| // contains exactly one path segment, such as "{var}" or "{var=*}", when | |
| // such a variable is expanded into a URL path on the client side, all | |
| // characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side | |
| // does the reverse decoding. Such variables show up in the Discovery Document | |
| // (https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a | |
| // variable contains multiple path segments, such as "{var=foo/*}" or | |
| // "{var=**}", when such a variable is expanded into a URL path on the client | |
| // side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The | |
| // server side does the reverse decoding, except "%2F" and "%2f" are left | |
| // unchanged. 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 (service | |
| // config) is a configuration language for configuring a gRPC service to become | |
| // a user-facing product. The service config is simply the YAML representation | |
| // of the `google.api.Service` proto message. As an alternative to annotating | |
| // your proto file, you can configure gRPC transcoding in your service config | |
| // YAML files. You do this by specifying a `HttpRule` that maps the gRPC method | |
| // to a REST endpoint, achieving the same effect as the proto annotation. This | |
| // can be particularly useful if you have a proto that is reused in multiple | |
| // services. Note that any transcoding specified in the service config will | |
| // override any matching transcoding configuration in the proto. The following | |
| // example 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 Transcoding | |
| // is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion | |
| // must follow the proto3 specification | |
| // (https://developers.google.com/protocol-buffers/docs/proto3#json). While the | |
| // single segment variable follows the semantics of RFC 6570 | |
| // (https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, | |
| // the multi segment variable **does not** follow RFC 6570 Section 3.2.3 | |
| // Reserved Expansion. The reason is that the Reserved Expansion does not | |
| // expand special characters like `?` and `#`, which would lead to invalid | |
| // URLs. As the result, gRPC Transcoding uses a custom encoding for multi | |
| // segment variables. The path variables **must not** refer to any repeated or | |
| // mapped field, because client libraries are not capable of handling such | |
| // variable expansion. The path variables **must not** capture the leading "/" | |
| // character. The reason is that the most common use case "{var}" does not | |
| // capture the leading "/" character. For consistency, all path variables must | |
| // share the same behavior. Repeated message fields must not be mapped to URL | |
| // query parameters, because no client library can support such complicated | |
| // mapping. 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, some | |
| // gRPC Transcoding implementations may not support this feature. | |
| 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. | |
| Body string `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. | |
| Delete string `json:"delete,omitempty"` | |
| // Get: Maps to HTTP GET. Used for listing and getting information about | |
| // resources. | |
| Get string `json:"get,omitempty"` | |
| // Patch: Maps to HTTP PATCH. Used for updating a resource. | |
| Patch string `json:"patch,omitempty"` | |
| // Post: Maps to HTTP POST. Used for creating a resource or performing an | |
| // action. | |
| Post string `json:"post,omitempty"` | |
| // Put: Maps to HTTP PUT. Used for replacing a resource. | |
| Put string `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. | |
| ResponseBody string `json:"responseBody,omitempty"` | |
| // Selector: Selects a method to which this rule applies. Refer to selector for | |
| // syntax details. | |
| Selector string `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:"-"` | |
| } | |
| func (s HttpRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod HttpRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Impact: A message to group impacts of updating a policy. | |
| type Impact struct { | |
| // Detail: Output only. User friendly impact detail in a free form message. | |
| Detail string `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_DEPENDENCY | |
| ImpactType string `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}.` | |
| MissingDependency string `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:"-"` | |
| } | |
| func (s Impact) MarshalJSON() ([]byte, error) { | |
| type NoMethod Impact | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ImportAdminOverridesMetadata: Metadata message that provides information | |
| // such as progress, partial failures, and similar information on each | |
| // GetOperation call of LRO returned by ImportAdminOverrides. | |
| type ImportAdminOverridesMetadata struct { | |
| } | |
| // ImportAdminOverridesResponse: Response message for ImportAdminOverrides | |
| 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:"-"` | |
| } | |
| func (s ImportAdminOverridesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod ImportAdminOverridesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ImportAdminQuotaPoliciesMetadata: Metadata message that provides information | |
| // such as progress, partial failures, and similar information on each | |
| // GetOperation call of LRO returned by ImportAdminQuotaPolicies. | |
| type ImportAdminQuotaPoliciesMetadata struct { | |
| } | |
| // ImportAdminQuotaPoliciesResponse: Response message for | |
| // ImportAdminQuotaPolicies | |
| 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:"-"` | |
| } | |
| func (s ImportAdminQuotaPoliciesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod ImportAdminQuotaPoliciesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ImportConsumerOverridesMetadata: Metadata message that provides information | |
| // such as progress, partial failures, and similar information on each | |
| // GetOperation call of LRO returned by ImportConsumerOverrides. | |
| type ImportConsumerOverridesMetadata struct { | |
| } | |
| // ImportConsumerOverridesResponse: Response message for | |
| // ImportConsumerOverrides | |
| 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:"-"` | |
| } | |
| func (s ImportConsumerOverridesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod ImportConsumerOverridesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // JavaSettings: Settings for Java client libraries. | |
| 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.v1 | |
| LibraryPackage string `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: SubscriptionAdmin | |
| ServiceClassNames 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:"-"` | |
| } | |
| func (s JavaSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod JavaSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // JwtLocation: Specifies a location to extract JWT from an API request. | |
| type JwtLocation struct { | |
| // Cookie: Specifies cookie name to extract JWT token. | |
| Cookie string `json:"cookie,omitempty"` | |
| // Header: Specifies HTTP header name to extract JWT token. | |
| Header string `json:"header,omitempty"` | |
| // Query: Specifies URL query parameter name to extract JWT token. | |
| Query string `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. | |
| ValuePrefix string `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:"-"` | |
| } | |
| func (s JwtLocation) MarshalJSON() ([]byte, error) { | |
| type NoMethod JwtLocation | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // LabelDescriptor: A description of a label. | |
| type LabelDescriptor struct { | |
| // Description: A human-readable description for the label. | |
| Description string `json:"description,omitempty"` | |
| // Key: The label key. | |
| Key string `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. | |
| ValueType string `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:"-"` | |
| } | |
| func (s LabelDescriptor) MarshalJSON() ([]byte, error) { | |
| type NoMethod LabelDescriptor | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ListOperationsResponse: The response message for Operations.ListOperations. | |
| type ListOperationsResponse struct { | |
| // NextPageToken: The standard List next-page token. | |
| NextPageToken string `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. For example, 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:"-"` | |
| } | |
| func (s ListOperationsResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod ListOperationsResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ListServicesResponse: Response message for the `ListServices` method. | |
| type ListServicesResponse struct { | |
| // NextPageToken: Token that can be passed to `ListServices` to resume a | |
| // paginated query. | |
| NextPageToken string `json:"nextPageToken,omitempty"` | |
| // Services: The available services for the requested project. | |
| Services []*GoogleApiServiceusageV1Service `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:"-"` | |
| } | |
| func (s ListServicesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod ListServicesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // LogDescriptor: A description of a log type. Example in YAML format: - name: | |
| // library.googleapis.com/activity_history description: The history of | |
| // borrowing and returning library items. display_name: Activity labels: - key: | |
| // /customer_id description: Identifier of a library customer | |
| type LogDescriptor struct { | |
| // Description: A human-readable description of this log. This information | |
| // appears in the documentation and can contain details. | |
| Description string `json:"description,omitempty"` | |
| // DisplayName: The human-readable name for this log. This information appears | |
| // on the user interface and should be concise. | |
| DisplayName string `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 [/_-.]. | |
| Name string `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:"-"` | |
| } | |
| func (s LogDescriptor) MarshalJSON() ([]byte, error) { | |
| type NoMethod LogDescriptor | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Logging: Logging configuration of the service. The following example shows | |
| // how to configure logs to be sent to the producer and consumer projects. In | |
| // the example, the `activity_history` log is sent to both the producer and | |
| // consumer projects, whereas the `purchase_history` log is only sent to the | |
| // producer project. monitored_resources: - type: library.googleapis.com/branch | |
| // labels: - key: /city description: The city where the library branch is | |
| // located in. - key: /name description: The name of the branch. logs: - name: | |
| // activity_history labels: - key: /customer_id - name: purchase_history | |
| // logging: producer_destinations: - monitored_resource: | |
| // library.googleapis.com/branch logs: - activity_history - purchase_history | |
| // consumer_destinations: - monitored_resource: library.googleapis.com/branch | |
| // logs: - activity_history | |
| 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:"-"` | |
| } | |
| func (s Logging) MarshalJSON() ([]byte, error) { | |
| type NoMethod Logging | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // LoggingDestination: Configuration of a specific logging destination (the | |
| // producer project or the consumer project). | |
| 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. | |
| MonitoredResource string `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:"-"` | |
| } | |
| func (s LoggingDestination) MarshalJSON() ([]byte, error) { | |
| type NoMethod LoggingDestination | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // LongRunning: Describes settings to use when generating API methods that use | |
| // the long-running operation pattern. All default values below are from those | |
| // used in the client library 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)). | |
| type LongRunning struct { | |
| // InitialPollDelay: Initial delay after which the first poll request will be | |
| // made. Default value: 5 seconds. | |
| InitialPollDelay string `json:"initialPollDelay,omitempty"` | |
| // MaxPollDelay: Maximum time between two subsequent poll requests. Default | |
| // value: 45 seconds. | |
| MaxPollDelay string `json:"maxPollDelay,omitempty"` | |
| // PollDelayMultiplier: Multiplier to gradually increase delay between | |
| // subsequent polls until it reaches max_poll_delay. Default value: 1.5. | |
| PollDelayMultiplier float64 `json:"pollDelayMultiplier,omitempty"` | |
| // TotalPollTimeout: Total polling timeout. Default value: 5 minutes. | |
| TotalPollTimeout string `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:"-"` | |
| } | |
| func (s LongRunning) MarshalJSON() ([]byte, error) { | |
| type NoMethod LongRunning | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| func (s *LongRunning) UnmarshalJSON(data []byte) error { | |
| type NoMethod LongRunning | |
| var s1 struct { | |
| PollDelayMultiplier gensupport.JSONFloat64 `json:"pollDelayMultiplier"` | |
| *NoMethod | |
| } | |
| s1.NoMethod = (*NoMethod)(s) | |
| if err := json.Unmarshal(data, &s1); err != nil { | |
| return err | |
| } | |
| s.PollDelayMultiplier = float64(s1.PollDelayMultiplier) | |
| return nil | |
| } | |
| // Method: Method represents a method of an API interface. New usages of this | |
| // message as an alternative to MethodDescriptorProto are strongly discouraged. | |
| // This message does not reliability preserve all information necessary to | |
| // model the schema and preserve semantics. Instead make use of | |
| // FileDescriptorSet which preserves the necessary information. | |
| 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. | |
| Edition string `json:"edition,omitempty"` | |
| // Name: The simple name of this method. | |
| Name string `json:"name,omitempty"` | |
| // Options: Any metadata attached to the method. | |
| Options []*Option `json:"options,omitempty"` | |
| // RequestStreaming: If true, the request is streamed. | |
| RequestStreaming bool `json:"requestStreaming,omitempty"` | |
| // RequestTypeUrl: A URL of the input message type. | |
| RequestTypeUrl string `json:"requestTypeUrl,omitempty"` | |
| // ResponseStreaming: If true, the response is streamed. | |
| ResponseStreaming bool `json:"responseStreaming,omitempty"` | |
| // ResponseTypeUrl: The URL of the output message type. | |
| ResponseTypeUrl string `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`. | |
| Syntax string `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:"-"` | |
| } | |
| func (s Method) MarshalJSON() ([]byte, error) { | |
| type NoMethod Method | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // MethodPolicy: Defines policies applying to an RPC method. | |
| 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 . | |
| Selector string `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:"-"` | |
| } | |
| func (s MethodPolicy) MarshalJSON() ([]byte, error) { | |
| type NoMethod MethodPolicy | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // MethodSettings: Describes the generator configuration for a method. | |
| 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_id | |
| AutoPopulatedFields []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: 10 | |
| Batching *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 minutes | |
| LongRunning *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... | |
| Selector string `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:"-"` | |
| } | |
| func (s MethodSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod MethodSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // MetricDescriptor: Defines a metric type and its schema. Once a metric | |
| // descriptor is created, deleting or altering it stops data collection and | |
| // makes the metric type's existing data unusable. | |
| type MetricDescriptor struct { | |
| // Description: A detailed description of the metric, which can be used in | |
| // documentation. | |
| Description string `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. | |
| DisplayName string `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. | |
| LaunchStage string `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. | |
| MetricKind string `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. | |
| Name string `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" | |
| Type string `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"). | |
| Unit string `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. | |
| ValueType string `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:"-"` | |
| } | |
| func (s MetricDescriptor) MarshalJSON() ([]byte, error) { | |
| type NoMethod MetricDescriptor | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // MetricDescriptorMetadata: Additional annotations that can be used to guide | |
| // the usage of a metric. | |
| 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. | |
| IngestDelay string `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. | |
| LaunchStage string `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. | |
| SamplePeriod string `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:"-"` | |
| } | |
| func (s MetricDescriptorMetadata) MarshalJSON() ([]byte, error) { | |
| type NoMethod MetricDescriptorMetadata | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // MetricRule: Bind API methods to metrics. Binding a method to a metric causes | |
| // that metric's configured quota behaviors to apply to the method call. | |
| type MetricRule struct { | |
| // AgenticMetricCosts: Optional. Metrics to update when the selected methods | |
| // are called, and the associated cost applied to each metric, iff the source | |
| // of the call is an agent. 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. | |
| AgenticMetricCosts map[string]string `json:"agenticMetricCosts,omitempty"` | |
| // 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"` | |
| // NonagenticMetricCosts: Optional. Metrics to update when the selected methods | |
| // are called, and the associated cost applied to each metric, iff the source | |
| // of the call is not an agent. 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. | |
| NonagenticMetricCosts map[string]string `json:"nonagenticMetricCosts,omitempty"` | |
| // Selector: Selects the methods to which this rule applies. Refer to selector | |
| // for syntax details. | |
| Selector string `json:"selector,omitempty"` | |
| // ForceSendFields is a list of field names (e.g. "AgenticMetricCosts") 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. "AgenticMetricCosts") 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:"-"` | |
| } | |
| func (s MetricRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod MetricRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Mixin: Declares an API Interface to be included in this interface. The | |
| // including interface must redeclare all the methods from the included | |
| // interface, but documentation and options are inherited as follows: - If | |
| // after comment and whitespace stripping, the documentation string of the | |
| // redeclared method is empty, it will be inherited from the original method. - | |
| // Each annotation belonging to the service config (http, visibility) which is | |
| // not set in the redeclared method will be inherited. - If an http annotation | |
| // is inherited, the path pattern will be modified as follows. Any version | |
| // prefix will be replaced by the version of the including interface plus the | |
| // root path if specified. Example of a simple mixin: package google.acl.v1; | |
| // service AccessControl { // Get the underlying ACL object. rpc | |
| // GetAcl(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. rpc | |
| // GetData(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 The | |
| // mixin construct implies that all methods in `AccessControl` are also | |
| // declared with same name and request/response types in `Storage`. A | |
| // documentation generator or annotation processor will see the effective | |
| // `Storage.GetAcl` method after inheriting documentation and annotations as | |
| // follows: service Storage { // Get the underlying ACL object. rpc | |
| // GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = | |
| // "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path pattern | |
| // changed from `v1` to `v2`. If the `root` field in the mixin is specified, it | |
| // should 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 inherited | |
| // HTTP annotation: service Storage { // Get the underlying ACL object. rpc | |
| // GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = | |
| // "/v2/acls/{resource=**}:getAcl"; } ... } | |
| type Mixin struct { | |
| // Name: The fully qualified name of the interface which is included. | |
| Name string `json:"name,omitempty"` | |
| // Root: If non-empty specifies a path under which inherited HTTP paths are | |
| // rooted. | |
| Root string `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:"-"` | |
| } | |
| func (s Mixin) MarshalJSON() ([]byte, error) { | |
| type NoMethod Mixin | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // MonitoredResourceDescriptor: An object that describes the schema of a | |
| // MonitoredResource object using a type name and a set of labels. For example, | |
| // the monitored resource descriptor for Google Compute Engine VM instances has | |
| // a type of "gce_instance" and specifies the use of the labels | |
| // "instance_id" and "zone" to identify particular VM instances. Different | |
| // APIs can support different monitored resource types. APIs generally provide | |
| // a `list` method that returns the monitored resource descriptors used by the | |
| // API. | |
| type MonitoredResourceDescriptor struct { | |
| // Description: Optional. A detailed description of the monitored resource type | |
| // that might be used in documentation. | |
| Description string `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". | |
| DisplayName string `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. | |
| LaunchStage string `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}". | |
| Name string `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). | |
| Type string `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:"-"` | |
| } | |
| func (s MonitoredResourceDescriptor) MarshalJSON() ([]byte, error) { | |
| type NoMethod MonitoredResourceDescriptor | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Monitoring: Monitoring configuration of the service. The example below shows | |
| // how to configure monitored resources and metrics for monitoring. In the | |
| // example, a monitored resource and two metrics are defined. The | |
| // `library.googleapis.com/book/returned_count` metric is sent to both producer | |
| // and 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: "A | |
| // branch of a library." launch_stage: GA labels: - key: resource_container | |
| // description: "The Cloud container (ie. project id) for the Branch." - key: | |
| // location description: "The location of the library branch." - key: branch_id | |
| // description: "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: GA | |
| // metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id | |
| // description: "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: GA | |
| // metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id | |
| // description: "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 | |
| 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:"-"` | |
| } | |
| func (s Monitoring) MarshalJSON() ([]byte, error) { | |
| type NoMethod Monitoring | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // MonitoringDestination: Configuration of a specific monitoring destination | |
| // (the producer project or the consumer project). | |
| 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. | |
| MonitoredResource string `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:"-"` | |
| } | |
| func (s MonitoringDestination) MarshalJSON() ([]byte, error) { | |
| type NoMethod MonitoringDestination | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // NodeSettings: Settings for Node client libraries. | |
| 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:"-"` | |
| } | |
| func (s NodeSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod NodeSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // OAuthRequirements: OAuth scopes are a way to define data and permissions on | |
| // data. For example, there are scopes defined for "Read-only access to Google | |
| // Calendar" and "Access to Cloud Platform". Users can consent to a scope for | |
| // an application, giving it permission to access that data on their behalf. | |
| // OAuth scope specifications should be fairly coarse grained; a user will need | |
| // to see and understand the text description of what your scope means. In most | |
| // cases: 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 OAuth | |
| // scope across all of those APIs. When you need finer grained OAuth consent | |
| // screens: talk with your product management about how developers will use | |
| // them in practice. Please note that even though each of the canonical scopes | |
| // is enough for a request to be accepted and passed to the backend, a request | |
| // can still fail due to the backend requiring additional scopes or | |
| // permissions. | |
| 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.read | |
| CanonicalScopes string `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:"-"` | |
| } | |
| func (s OAuthRequirements) MarshalJSON() ([]byte, error) { | |
| type NoMethod OAuthRequirements | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Operation: This resource represents a long-running operation that is the | |
| // result of a network API call. | |
| 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. | |
| Done bool `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. | |
| Metadata googleapi.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}`. | |
| Name string `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`. | |
| Response googleapi.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:"-"` | |
| } | |
| func (s Operation) MarshalJSON() ([]byte, error) { | |
| type NoMethod Operation | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // OperationMetadata: The operation metadata returned for the batchend services | |
| // operation. | |
| 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:"-"` | |
| } | |
| func (s OperationMetadata) MarshalJSON() ([]byte, error) { | |
| type NoMethod OperationMetadata | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Option: A protocol buffer option, which can be attached to a message, field, | |
| // enumeration, etc. New usages of this message as an alternative to | |
| // FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, | |
| // ServiceOptions, or MethodOptions are strongly discouraged. | |
| 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". | |
| Name string `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. | |
| Value googleapi.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:"-"` | |
| } | |
| func (s Option) MarshalJSON() ([]byte, error) { | |
| type NoMethod Option | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Page: Represents a documentation page. A page can contain subpages to | |
| // represent nested documentation set structure. | |
| 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. | |
| Content string `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`. | |
| Name string `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:"-"` | |
| } | |
| func (s Page) MarshalJSON() ([]byte, error) { | |
| type NoMethod Page | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // PhpSettings: Settings for Php client libraries. | |
| 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\V1 | |
| LibraryPackage string `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:"-"` | |
| } | |
| func (s PhpSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod PhpSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Publishing: This message configures the settings for publishing Google Cloud | |
| // Client libraries (https://cloud.google.com/apis/docs/cloud-client-libraries) | |
| // generated from the service config. | |
| 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". | |
| ApiShortName string `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. | |
| DocTagPrefix string `json:"docTagPrefix,omitempty"` | |
| // DocumentationUri: Link to product home page. Example: | |
| // https://cloud.google.com/asset-inventory/docs/overview | |
| DocumentationUri string `json:"documentationUri,omitempty"` | |
| // GithubLabel: GitHub label to apply to issues and pull requests opened for | |
| // this API. | |
| GithubLabel string `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=1161103 | |
| NewIssueUri string `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.google | |
| // "HEALTH" - Health Org. | |
| Organization string `json:"organization,omitempty"` | |
| // ProtoReferenceDocumentationUri: Optional link to proto reference | |
| // documentation. Example: | |
| // https://cloud.google.com/pubsub/lite/docs/reference/rpc | |
| ProtoReferenceDocumentationUri string `json:"protoReferenceDocumentationUri,omitempty"` | |
| // RestReferenceDocumentationUri: Optional link to REST reference | |
| // documentation. Example: | |
| // https://cloud.google.com/pubsub/lite/docs/reference/rest | |
| RestReferenceDocumentationUri string `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:"-"` | |
| } | |
| func (s Publishing) MarshalJSON() ([]byte, error) { | |
| type NoMethod Publishing | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // PythonSettings: Settings for Python client libraries. | |
| 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:"-"` | |
| } | |
| func (s PythonSettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod PythonSettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Quota: Quota configuration helps to achieve fairness and budgeting in | |
| // service usage. The metric based quota configuration works this way: - The | |
| // service configuration defines a set of metrics. - For API calls, the | |
| // quota.metric_rules maps methods to metrics with corresponding costs. - The | |
| // quota.limits defines limits on the metrics, which will be used for quota | |
| // checks 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 for | |
| // consumer projects values: STANDARD: 10000 (The metric rules bind all methods | |
| // to the read_calls metric, except for the UpdateBook and DeleteBook methods. | |
| // These two methods are mapped to the write_calls metric, with the UpdateBook | |
| // method 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: Read | |
| // requests metric_kind: DELTA value_type: INT64 - name: | |
| // library.googleapis.com/write_calls display_name: Write requests metric_kind: | |
| // DELTA value_type: INT64 | |
| 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:"-"` | |
| } | |
| func (s Quota) MarshalJSON() ([]byte, error) { | |
| type NoMethod Quota | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // QuotaLimit: `QuotaLimit` defines a specific limit that applies over a | |
| // specified duration for a limit type. There can be at most one limit for a | |
| // duration and limit type combination defined within a `QuotaGroup`. | |
| 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. | |
| DefaultLimit int64 `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`). | |
| Description string `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. | |
| DisplayName string `json:"displayName,omitempty"` | |
| // Duration: Duration of this limit in textual notation. Must be "100s" or | |
| // "1d". Used by group-based quotas only. | |
| Duration string `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. | |
| FreeTier int64 `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. | |
| MaxLimit int64 `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. | |
| Metric string `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. | |
| Name string `json:"name,omitempty"` | |
| // TrafficSource: Optional. This is only informational, the logic to allocate | |
| // the quota to the correct metric (such as in `metric_rules`) should identify | |
| // which quota metrics to allocate to. | |
| // | |
| // Possible values: | |
| // "TRAFFIC_SOURCE_UNSPECIFIED" - This quota limit applies to all traffic. | |
| // This is the default value. | |
| // "TRAFFIC_SOURCE_NONAGENTIC" - This quota limit applies to traffic not | |
| // recognized as agentic. | |
| // "TRAFFIC_SOURCE_AGENTIC" - This quota limit applies to only agentic | |
| // traffic. | |
| TrafficSource string `json:"trafficSource,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. | |
| Unit string `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:"-"` | |
| } | |
| func (s QuotaLimit) MarshalJSON() ([]byte, error) { | |
| type NoMethod QuotaLimit | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // QuotaOverride: A quota override | |
| 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. | |
| AdminOverrideAncestor string `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` | |
| Metric string `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. | |
| Name string `json:"name,omitempty"` | |
| // OverrideValue: The overriding quota limit value. Can be any nonnegative | |
| // integer, or -1 (unlimited quota). | |
| OverrideValue int64 `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. | |
| Unit string `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:"-"` | |
| } | |
| func (s QuotaOverride) MarshalJSON() ([]byte, error) { | |
| type NoMethod QuotaOverride | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // RemoveEnableRulesMetadata: Metadata for the `RemoveEnableRules` method. | |
| type RemoveEnableRulesMetadata struct { | |
| } | |
| // RemoveEnableRulesResponse: The response message of `RemoveEnableRules` | |
| // method. | |
| 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`. | |
| Parent string `json:"parent,omitempty"` | |
| // RemovedValues: Deprecated: This field is no longer populated. Use | |
| // GetConsumerPolicy to verify the remaining enabled values. | |
| 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:"-"` | |
| } | |
| func (s RemoveEnableRulesResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod RemoveEnableRulesResponse | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // RubySettings: Settings for Ruby client libraries. | |
| 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:"-"` | |
| } | |
| func (s RubySettings) MarshalJSON() ([]byte, error) { | |
| type NoMethod RubySettings | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // SelectiveGapicGeneration: This message is used to configure the generation | |
| // of a subset of the RPCs in a service for client libraries. Note: This | |
| // feature should not be used in most cases. | |
| 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. | |
| GenerateOmittedAsInternal bool `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:"-"` | |
| } | |
| func (s SelectiveGapicGeneration) MarshalJSON() ([]byte, error) { | |
| type NoMethod SelectiveGapicGeneration | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // ServiceIdentity: Service identity for a service. This is the identity that | |
| // service producer should use to access consumer resources. | |
| type ServiceIdentity struct { | |
| // Email: The email address of the service account that a service producer | |
| // would use to access consumer resources. | |
| Email string `json:"email,omitempty"` | |
| // UniqueId: The unique and stable id of the service account. | |
| // https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount | |
| UniqueId string `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:"-"` | |
| } | |
| func (s ServiceIdentity) MarshalJSON() ([]byte, error) { | |
| type NoMethod ServiceIdentity | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // SourceContext: `SourceContext` represents information about the source of a | |
| // protobuf element, like the file in which it is defined. | |
| 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". | |
| FileName string `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:"-"` | |
| } | |
| func (s SourceContext) MarshalJSON() ([]byte, error) { | |
| type NoMethod SourceContext | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // SourceInfo: Source information used to create a Service Config | |
| 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:"-"` | |
| } | |
| func (s SourceInfo) MarshalJSON() ([]byte, error) { | |
| type NoMethod SourceInfo | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Status: The `Status` type defines a logical error model that is suitable for | |
| // different programming environments, including REST APIs and RPC APIs. It is | |
| // used by gRPC (https://github.com/grpc). Each `Status` message contains three | |
| // pieces of data: error code, error message, and error details. You can find | |
| // out more about this error model and how to work with it in the API Design | |
| // Guide (https://cloud.google.com/apis/design/errors). | |
| type Status struct { | |
| // Code: The status code, which should be an enum value of google.rpc.Code. | |
| Code int64 `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. | |
| Message string `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:"-"` | |
| } | |
| func (s Status) MarshalJSON() ([]byte, error) { | |
| type NoMethod Status | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // SystemParameter: Define a parameter's name and location. The parameter may | |
| // be passed as either an HTTP header or a URL query parameter, and if both are | |
| // passed the behavior is implementation-dependent. | |
| type SystemParameter struct { | |
| // HttpHeader: Define the HTTP header name to use for the parameter. It is case | |
| // insensitive. | |
| HttpHeader string `json:"httpHeader,omitempty"` | |
| // Name: Define the name of the parameter, such as "api_key" . It is case | |
| // sensitive. | |
| Name string `json:"name,omitempty"` | |
| // UrlQueryParameter: Define the URL query parameter name to use for the | |
| // parameter. It is case sensitive. | |
| UrlQueryParameter string `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:"-"` | |
| } | |
| func (s SystemParameter) MarshalJSON() ([]byte, error) { | |
| type NoMethod SystemParameter | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // SystemParameterRule: Define a system parameter rule mapping system parameter | |
| // definitions to methods. | |
| 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. | |
| Selector string `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:"-"` | |
| } | |
| func (s SystemParameterRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod SystemParameterRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // SystemParameters: ### System parameter configuration A system parameter is a | |
| // special kind of parameter defined by the API system, not by an individual | |
| // API. It is typically mapped to an HTTP header and/or a URL query parameter. | |
| // This configuration specifies which methods change the names of the system | |
| // parameters. | |
| 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:"-"` | |
| } | |
| func (s SystemParameters) MarshalJSON() ([]byte, error) { | |
| type NoMethod SystemParameters | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // Type: A protocol buffer message type. New usages of this message as an | |
| // alternative to DescriptorProto are strongly discouraged. This message does | |
| // not reliability preserve all information necessary to model the schema and | |
| // preserve semantics. Instead make use of FileDescriptorSet which preserves | |
| // the necessary information. | |
| type Type struct { | |
| // Edition: The source edition string, only valid when syntax is | |
| // SYNTAX_EDITIONS. | |
| Edition string `json:"edition,omitempty"` | |
| // Fields: The list of fields. | |
| Fields []*Field `json:"fields,omitempty"` | |
| // Name: The fully qualified message name. | |
| Name string `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`. | |
| Syntax string `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:"-"` | |
| } | |
| func (s Type) MarshalJSON() ([]byte, error) { | |
| type NoMethod Type | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // UpdateAdminQuotaPolicyMetadata: Metadata message that provides information | |
| // such as progress, partial failures, and similar information on each | |
| // GetOperation call of LRO returned by UpdateAdminQuotaPolicy. | |
| type UpdateAdminQuotaPolicyMetadata struct { | |
| } | |
| // UpdateConsumerPolicyMetadata: Metadata for the `UpdateConsumerPolicy` | |
| // method. | |
| type UpdateConsumerPolicyMetadata struct { | |
| } | |
| // UpdateContentSecurityPolicyMetadata: Metadata for the | |
| // `UpdateContentSecurityPolicy` method. | |
| type UpdateContentSecurityPolicyMetadata struct { | |
| } | |
| // Usage: Configuration controlling usage of a service. | |
| 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. | |
| ProducerNotificationChannel string `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. 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. "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:"-"` | |
| } | |
| func (s Usage) MarshalJSON() ([]byte, error) { | |
| type NoMethod Usage | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| // UsageRule: Usage configuration rules for the service. | |
| 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. | |
| AllowUnregisteredCalls bool `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. | |
| Selector string `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. | |
| SkipServiceControl bool `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:"-"` | |
| } | |
| func (s UsageRule) MarshalJSON() ([]byte, error) { | |
| type NoMethod UsageRule | |
| return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) | |
| } | |
| type OperationsCancelCall struct { | |
| s *Service | |
| name string | |
| canceloperationrequest *CancelOperationRequest | |
| urlParams_ gensupport.URLParams | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // Cancel: Starts asynchronous cancellation on a long-running operation. The | |
| // server makes a best effort to cancel the operation, but success is not | |
| // guaranteed. If the server doesn't support this method, it returns | |
| // `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or | |
| // other methods to check whether the cancellation succeeded or whether the | |
| // operation completed despite cancellation. On successful cancellation, the | |
| // operation is not deleted; instead, it becomes an operation with an | |
| // Operation.error value with a google.rpc.Status.code of `1`, corresponding to | |
| // `Code.CANCELLED`. | |
| // | |
| // - name: The name of the operation resource to be cancelled. | |
| func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall { | |
| c := &OperationsCancelCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| c.canceloperationrequest = canceloperationrequest | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *OperationsCancelCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *OperationsCancelCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) | |
| body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.canceloperationrequest) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:cancel") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("POST", urls, body) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.operations.cancel", "request", internallog.HTTPRequest(req, body.Bytes())) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // Do executes the "serviceusage.operations.cancel" call. | |
| // Any non-2xx status code is an error. Response headers are in either | |
| // *Empty.ServerResponse.Header or (if a response was returned at all) in | |
| // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check | |
| // whether the returned error was because http.StatusNotModified was returned. | |
| func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &Empty{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.operations.cancel", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| type OperationsDeleteCall struct { | |
| s *Service | |
| name string | |
| urlParams_ gensupport.URLParams | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // Delete: Deletes a long-running operation. This method indicates that the | |
| // client is no longer interested in the operation result. It does not cancel | |
| // the operation. If the server doesn't support this method, it returns | |
| // `google.rpc.Code.UNIMPLEMENTED`. | |
| // | |
| // - name: The name of the operation resource to be deleted. | |
| func (r *OperationsService) Delete(name string) *OperationsDeleteCall { | |
| c := &OperationsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *OperationsDeleteCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *OperationsDeleteCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("DELETE", urls, nil) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.operations.delete", "request", internallog.HTTPRequest(req, nil)) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // Do executes the "serviceusage.operations.delete" call. | |
| // Any non-2xx status code is an error. Response headers are in either | |
| // *Empty.ServerResponse.Header or (if a response was returned at all) in | |
| // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check | |
| // whether the returned error was because http.StatusNotModified was returned. | |
| func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &Empty{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.operations.delete", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| type OperationsGetCall struct { | |
| s *Service | |
| name string | |
| urlParams_ gensupport.URLParams | |
| ifNoneMatch_ string | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // Get: Gets the latest state of a long-running operation. Clients can use this | |
| // method to poll the operation result at intervals as recommended by the API | |
| // service. | |
| // | |
| // - name: The name of the operation resource. | |
| func (r *OperationsService) Get(name string) *OperationsGetCall { | |
| c := &OperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // IfNoneMatch sets an optional parameter which makes the operation fail if the | |
| // object's ETag matches the given value. This is useful for getting updates | |
| // only after the object has changed since the last request. | |
| func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall { | |
| c.ifNoneMatch_ = entityTag | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *OperationsGetCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *OperationsGetCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) | |
| if c.ifNoneMatch_ != "" { | |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("GET", urls, nil) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.operations.get", "request", internallog.HTTPRequest(req, nil)) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // 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) in | |
| // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check | |
| // whether the returned error was because http.StatusNotModified was returned. | |
| func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &Operation{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.operations.get", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| type OperationsListCall struct { | |
| s *Service | |
| urlParams_ gensupport.URLParams | |
| ifNoneMatch_ string | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // List: Lists operations that match the specified filter in the request. If | |
| // the server doesn't support this method, it returns `UNIMPLEMENTED`. | |
| func (r *OperationsService) List() *OperationsListCall { | |
| c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| return c | |
| } | |
| // Filter sets the optional parameter "filter": The standard list filter. | |
| func (c *OperationsListCall) Filter(filter string) *OperationsListCall { | |
| c.urlParams_.Set("filter", filter) | |
| return c | |
| } | |
| // Name sets the optional parameter "name": The name of the operation's parent | |
| // resource. | |
| func (c *OperationsListCall) Name(name string) *OperationsListCall { | |
| c.urlParams_.Set("name", name) | |
| return c | |
| } | |
| // PageSize sets the optional parameter "pageSize": The standard list page | |
| // size. | |
| func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall { | |
| c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) | |
| return c | |
| } | |
| // PageToken sets the optional parameter "pageToken": The standard list page | |
| // token. | |
| func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall { | |
| c.urlParams_.Set("pageToken", pageToken) | |
| return c | |
| } | |
| // 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` when | |
| // reading across collections. For example, when `parent` is set to | |
| // "projects/example/locations/-". This field is not supported by default and | |
| // will result in an `UNIMPLEMENTED` error if set unless explicitly documented | |
| // otherwise in service or product specific documentation. | |
| func (c *OperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *OperationsListCall { | |
| c.urlParams_.Set("returnPartialSuccess", fmt.Sprint(returnPartialSuccess)) | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // IfNoneMatch sets an optional parameter which makes the operation fail if the | |
| // object's ETag matches the given value. This is useful for getting updates | |
| // only after the object has changed since the last request. | |
| func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall { | |
| c.ifNoneMatch_ = entityTag | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *OperationsListCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *OperationsListCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) | |
| if c.ifNoneMatch_ != "" { | |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/operations") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("GET", urls, nil) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.operations.list", "request", internallog.HTTPRequest(req, nil)) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // 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 returned | |
| // at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to | |
| // check whether the returned error was because http.StatusNotModified was | |
| // returned. | |
| func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &ListOperationsResponse{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.operations.list", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| // 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 (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error { | |
| c.ctx_ = ctx | |
| defer c.PageToken(c.urlParams_.Get("pageToken")) | |
| for { | |
| x, err := c.Do() | |
| if err != nil { | |
| return err | |
| } | |
| if err := f(x); err != nil { | |
| return err | |
| } | |
| if x.NextPageToken == "" { | |
| return nil | |
| } | |
| c.PageToken(x.NextPageToken) | |
| } | |
| } | |
| type ServicesBatchEnableCall struct { | |
| s *Service | |
| parent string | |
| batchenableservicesrequest *BatchEnableServicesRequest | |
| urlParams_ gensupport.URLParams | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // BatchEnable: Enable multiple services on a project. The operation is atomic: | |
| // if enabling any service fails, then the entire batch fails, and no state | |
| // changes occur. To enable a single service, use the `EnableService` method | |
| // instead. | |
| // | |
| // - parent: Parent to enable services on. An example name would be: | |
| // `projects/123` where `123` is the project number. The | |
| // `BatchEnableServices` method currently only supports projects. | |
| func (r *ServicesService) BatchEnable(parent string, batchenableservicesrequest *BatchEnableServicesRequest) *ServicesBatchEnableCall { | |
| c := &ServicesBatchEnableCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.parent = parent | |
| c.batchenableservicesrequest = batchenableservicesrequest | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *ServicesBatchEnableCall) Fields(s ...googleapi.Field) *ServicesBatchEnableCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *ServicesBatchEnableCall) Context(ctx context.Context) *ServicesBatchEnableCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *ServicesBatchEnableCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *ServicesBatchEnableCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) | |
| body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.batchenableservicesrequest) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/services:batchEnable") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("POST", urls, body) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "parent": c.parent, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.services.batchEnable", "request", internallog.HTTPRequest(req, body.Bytes())) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // 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) in | |
| // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check | |
| // whether the returned error was because http.StatusNotModified was returned. | |
| func (c *ServicesBatchEnableCall) Do(opts ...googleapi.CallOption) (*Operation, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &Operation{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.services.batchEnable", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| type ServicesBatchGetCall struct { | |
| s *Service | |
| parent string | |
| urlParams_ gensupport.URLParams | |
| ifNoneMatch_ string | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // BatchGet: Returns the service configurations and enabled states for a given | |
| // list of services. | |
| // | |
| // - parent: Parent to retrieve services from. If this is set, the parent of | |
| // all of the services specified in `names` must match this field. An example | |
| // name would be: `projects/123` where `123` is the project number. The | |
| // `BatchGetServices` method currently only supports projects. | |
| func (r *ServicesService) BatchGet(parent string) *ServicesBatchGetCall { | |
| c := &ServicesBatchGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.parent = parent | |
| return c | |
| } | |
| // Names sets the optional parameter "names": Names of the services to | |
| // retrieve. An example name would be: | |
| // `projects/123/services/serviceusage.googleapis.com` where `123` is the | |
| // project number. A single request can get a maximum of 30 services at a time. | |
| func (c *ServicesBatchGetCall) Names(names ...string) *ServicesBatchGetCall { | |
| c.urlParams_.SetMulti("names", append([]string{}, names...)) | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *ServicesBatchGetCall) Fields(s ...googleapi.Field) *ServicesBatchGetCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // IfNoneMatch sets an optional parameter which makes the operation fail if the | |
| // object's ETag matches the given value. This is useful for getting updates | |
| // only after the object has changed since the last request. | |
| func (c *ServicesBatchGetCall) IfNoneMatch(entityTag string) *ServicesBatchGetCall { | |
| c.ifNoneMatch_ = entityTag | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *ServicesBatchGetCall) Context(ctx context.Context) *ServicesBatchGetCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *ServicesBatchGetCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *ServicesBatchGetCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) | |
| if c.ifNoneMatch_ != "" { | |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/services:batchGet") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("GET", urls, nil) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "parent": c.parent, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.services.batchGet", "request", internallog.HTTPRequest(req, nil)) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // Do executes the "serviceusage.services.batchGet" call. | |
| // Any non-2xx status code is an error. Response headers are in either | |
| // *BatchGetServicesResponse.ServerResponse.Header or (if a response was | |
| // returned at all) in error.(*googleapi.Error).Header. Use | |
| // googleapi.IsNotModified to check whether the returned error was because | |
| // http.StatusNotModified was returned. | |
| func (c *ServicesBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetServicesResponse, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &BatchGetServicesResponse{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.services.batchGet", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| type ServicesDisableCall struct { | |
| s *Service | |
| name string | |
| disableservicerequest *DisableServiceRequest | |
| urlParams_ gensupport.URLParams | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // Disable: Disable a service so that it can no longer be used with a project. | |
| // This prevents unintended usage that may cause unexpected billing charges or | |
| // security leaks. It is not valid to call the disable method on a service that | |
| // is not currently enabled. Callers will receive a `FAILED_PRECONDITION` | |
| // status if the target service is not currently enabled. | |
| // | |
| // - name: Name of the consumer and service to disable the service on. The | |
| // enable and disable methods currently only support projects. An example | |
| // name would be: `projects/123/services/serviceusage.googleapis.com` where | |
| // `123` is the project number. | |
| func (r *ServicesService) Disable(name string, disableservicerequest *DisableServiceRequest) *ServicesDisableCall { | |
| c := &ServicesDisableCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| c.disableservicerequest = disableservicerequest | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *ServicesDisableCall) Fields(s ...googleapi.Field) *ServicesDisableCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *ServicesDisableCall) Context(ctx context.Context) *ServicesDisableCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *ServicesDisableCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *ServicesDisableCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) | |
| body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.disableservicerequest) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:disable") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("POST", urls, body) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.services.disable", "request", internallog.HTTPRequest(req, body.Bytes())) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // 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) in | |
| // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check | |
| // whether the returned error was because http.StatusNotModified was returned. | |
| func (c *ServicesDisableCall) Do(opts ...googleapi.CallOption) (*Operation, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &Operation{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.services.disable", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| type ServicesEnableCall struct { | |
| s *Service | |
| name string | |
| enableservicerequest *EnableServiceRequest | |
| urlParams_ gensupport.URLParams | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // Enable: Enable a service so that it can be used with a project. | |
| // | |
| // - name: Name of the consumer and service to enable the service on. The | |
| // `EnableService` and `DisableService` methods currently only support | |
| // projects. Enabling a service requires that the service is public or is | |
| // shared with the user enabling the service. An example name would be: | |
| // `projects/123/services/serviceusage.googleapis.com` where `123` is the | |
| // project number. | |
| func (r *ServicesService) Enable(name string, enableservicerequest *EnableServiceRequest) *ServicesEnableCall { | |
| c := &ServicesEnableCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| c.enableservicerequest = enableservicerequest | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *ServicesEnableCall) Fields(s ...googleapi.Field) *ServicesEnableCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *ServicesEnableCall) Context(ctx context.Context) *ServicesEnableCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *ServicesEnableCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *ServicesEnableCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) | |
| body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.enableservicerequest) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:enable") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("POST", urls, body) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.services.enable", "request", internallog.HTTPRequest(req, body.Bytes())) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // 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) in | |
| // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check | |
| // whether the returned error was because http.StatusNotModified was returned. | |
| func (c *ServicesEnableCall) Do(opts ...googleapi.CallOption) (*Operation, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &Operation{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.services.enable", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| type ServicesGetCall struct { | |
| s *Service | |
| name string | |
| urlParams_ gensupport.URLParams | |
| ifNoneMatch_ string | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // Get: Returns the service configuration and enabled state for a given | |
| // service. | |
| // | |
| // - name: Name of the consumer and service to get the `ConsumerState` for. An | |
| // example name would be: `projects/123/services/serviceusage.googleapis.com` | |
| // where `123` is the project number. | |
| func (r *ServicesService) Get(name string) *ServicesGetCall { | |
| c := &ServicesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *ServicesGetCall) Fields(s ...googleapi.Field) *ServicesGetCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // IfNoneMatch sets an optional parameter which makes the operation fail if the | |
| // object's ETag matches the given value. This is useful for getting updates | |
| // only after the object has changed since the last request. | |
| func (c *ServicesGetCall) IfNoneMatch(entityTag string) *ServicesGetCall { | |
| c.ifNoneMatch_ = entityTag | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *ServicesGetCall) Context(ctx context.Context) *ServicesGetCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *ServicesGetCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *ServicesGetCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) | |
| if c.ifNoneMatch_ != "" { | |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("GET", urls, nil) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.services.get", "request", internallog.HTTPRequest(req, nil)) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // Do executes the "serviceusage.services.get" call. | |
| // Any non-2xx status code is an error. Response headers are in either | |
| // *GoogleApiServiceusageV1Service.ServerResponse.Header or (if a response was | |
| // returned at all) in error.(*googleapi.Error).Header. Use | |
| // googleapi.IsNotModified to check whether the returned error was because | |
| // http.StatusNotModified was returned. | |
| func (c *ServicesGetCall) Do(opts ...googleapi.CallOption) (*GoogleApiServiceusageV1Service, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &GoogleApiServiceusageV1Service{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.services.get", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| type ServicesListCall struct { | |
| s *Service | |
| parent string | |
| urlParams_ gensupport.URLParams | |
| ifNoneMatch_ string | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // List: List all services available to the specified project, and the current | |
| // state of those services with respect to the project. The list includes all | |
| // public services, all services for which the calling user has the | |
| // `servicemanagement.services.bind` permission, and all services that have | |
| // already been enabled on the project. The list can be filtered to only | |
| // include services in a specific state, for example to only include services | |
| // enabled on the project. WARNING: If you need to query enabled services | |
| // frequently or across an organization, you should use Cloud Asset Inventory | |
| // API (https://cloud.google.com/asset-inventory/docs/apis), which provides | |
| // higher throughput and richer filtering capability. | |
| // | |
| // - parent: Parent to search for services on. An example name would be: | |
| // `projects/123` where `123` is the project number. | |
| func (r *ServicesService) List(parent string) *ServicesListCall { | |
| c := &ServicesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.parent = parent | |
| return c | |
| } | |
| // Filter sets the optional parameter "filter": Only list services that conform | |
| // to the given filter. The allowed filter strings are `state:ENABLED` and | |
| // `state:DISABLED`. | |
| func (c *ServicesListCall) Filter(filter string) *ServicesListCall { | |
| c.urlParams_.Set("filter", filter) | |
| return c | |
| } | |
| // PageSize sets the optional parameter "pageSize": Requested size of the next | |
| // page of data. Requested page size cannot exceed 200. If not set, the default | |
| // page size is 50. | |
| func (c *ServicesListCall) PageSize(pageSize int64) *ServicesListCall { | |
| c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) | |
| return c | |
| } | |
| // PageToken sets the optional parameter "pageToken": Token identifying which | |
| // result to start with, which is returned by a previous list call. | |
| func (c *ServicesListCall) PageToken(pageToken string) *ServicesListCall { | |
| c.urlParams_.Set("pageToken", pageToken) | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more | |
| // details. | |
| func (c *ServicesListCall) Fields(s ...googleapi.Field) *ServicesListCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // IfNoneMatch sets an optional parameter which makes the operation fail if the | |
| // object's ETag matches the given value. This is useful for getting updates | |
| // only after the object has changed since the last request. | |
| func (c *ServicesListCall) IfNoneMatch(entityTag string) *ServicesListCall { | |
| c.ifNoneMatch_ = entityTag | |
| return c | |
| } | |
| // Context sets the context to be used in this call's Do method. | |
| func (c *ServicesListCall) Context(ctx context.Context) *ServicesListCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns a http.Header that can be modified by the caller to add | |
| // headers to the request. | |
| func (c *ServicesListCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *ServicesListCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) | |
| if c.ifNoneMatch_ != "" { | |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) | |
| } | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/services") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("GET", urls, nil) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "parent": c.parent, | |
| }) | |
| c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "serviceusage.services.list", "request", internallog.HTTPRequest(req, nil)) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // 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 returned | |
| // at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to | |
| // check whether the returned error was because http.StatusNotModified was | |
| // returned. | |
| func (c *ServicesListCall) Do(opts ...googleapi.CallOption) (*ListServicesResponse, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, gensupport.WrapError(&googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| }) | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, gensupport.WrapError(err) | |
| } | |
| ret := &ListServicesResponse{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| b, err := gensupport.DecodeResponseBytes(target, res) | |
| if err != nil { | |
| return nil, err | |
| } | |
| c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "serviceusage.services.list", "response", internallog.HTTPResponse(res, b)) | |
| return ret, nil | |
| } | |
| // 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 (c *ServicesListCall) Pages(ctx context.Context, f func(*ListServicesResponse) error) error { | |
| c.ctx_ = ctx | |
| defer c.PageToken(c.urlParams_.Get("pageToken")) | |
| for { | |
| x, err := c.Do() | |
| if err != nil { | |
| return err | |
| } | |
| if err := f(x); err != nil { | |
| return err | |
| } | |
| if x.NextPageToken == "" { | |
| return nil | |
| } | |
| c.PageToken(x.NextPageToken) | |
| } | |
| } |