@datafire/google_serviceusage v4.0.0

@datafire/google_serviceusage

Client library for Service Usage API

Installation and Usage

npm install --save @datafire/google_serviceusage

let google_serviceusage = require('@datafire/google_serviceusage').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_serviceusage.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_serviceusage.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

serviceusage.operations.list

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

google_serviceusage.serviceusage.operations.list({}, context)

Input

• input object
  • filter string: The standard list filter.
  • name string: The name of the operation's parent resource.
  • pageSize integer: The standard list page size.
  • pageToken string: The standard list page token.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListOperationsResponse

serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.delete

Deletes a consumer override.

google_serviceusage.serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.delete({
  "name": ""
}, context)

Input

• input object
  • name required string: The resource name of the override to delete. An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d
  • force boolean: Whether to force the deletion of the quota override. If deleting an override would cause the effective quota for the consumer to decrease by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.consumerQuotaMetrics.limits.get

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

google_serviceusage.serviceusage.services.consumerQuotaMetrics.limits.get({
  "name": ""
}, context)

Input

• input object
  • name required string: The resource name of the quota limit. Use the quota limit resource name returned by previous ListConsumerQuotaMetrics and GetConsumerQuotaMetric API calls.
  • view string (values: QUOTA_VIEW_UNSPECIFIED, BASIC, FULL): Specifies the level of detail for quota information in the response.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ConsumerQuotaLimit

serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.patch

Updates a consumer override.

google_serviceusage.serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.patch({
  "name": ""
}, context)

Input

• input object
  • name required string: The resource name of the override to update. An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d
  • force boolean: Whether to force the update of the quota override. If updating an override would cause the effective quota for the consumer to decrease by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.
  • updateMask string: Update only the specified fields of the override. If unset, all fields will be updated.
  • body QuotaOverride
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.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. Operation

google_serviceusage.serviceusage.services.disable({
  "name": ""
}, context)

Input

• input object
  • name required string: 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 (not project ID).
  • body DisableServiceRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.enable

Enable a service so that it can be used with a project. Operation

google_serviceusage.serviceusage.services.enable({
  "name": ""
}, context)

Input

• input object
  • name required string: 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 (not project ID).
  • body EnableServiceRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.list

Lists all admin overrides on this limit.

google_serviceusage.serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.list({
  "parent": ""
}, context)

Input

• input object
  • parent required string: The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion
  • pageSize integer: Requested size of the next page of data.
  • pageToken string: Token identifying which result to start with; returned by a previous list call.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListAdminOverridesResponse

serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.create

Creates an admin override. An admin override is applied by an administrator of a parent folder or parent organization of the consumer receiving the override. An admin override is intended to limit the amount of quota the consumer can use out of the total quota pool allocated to all children of the folder or organization.

google_serviceusage.serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.create({
  "parent": ""
}, context)

Input

• input object
  • parent required string: The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion
  • force boolean: Whether to force the creation of the quota override. If creating an override would cause the effective quota for the consumer to decrease by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.
  • body QuotaOverride
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.list

Lists all consumer overrides on this limit.

google_serviceusage.serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.list({
  "parent": ""
}, context)

Input

• input object
  • parent required string: The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion
  • pageSize integer: Requested size of the next page of data.
  • pageToken string: Token identifying which result to start with; returned by a previous list call.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListConsumerOverridesResponse

serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.create

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

google_serviceusage.serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.create({
  "parent": ""
}, context)

Input

• input object
  • parent required string: The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion
  • force boolean: Whether to force the creation of the quota override. If creating an override would cause the effective quota for the consumer to decrease by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.
  • body QuotaOverride
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.consumerQuotaMetrics.list

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

google_serviceusage.serviceusage.services.consumerQuotaMetrics.list({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Parent of the quotas resource. Some example names would be: projects/123/services/serviceconsumermanagement.googleapis.com folders/345/services/serviceconsumermanagement.googleapis.com organizations/456/services/serviceconsumermanagement.googleapis.com
  • pageSize integer: Requested size of the next page of data.
  • pageToken string: Token identifying which result to start with; returned by a previous list call.
  • view string (values: QUOTA_VIEW_UNSPECIFIED, BASIC, FULL): Specifies the level of detail for quota information in the response.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListConsumerQuotaMetricsResponse

serviceusage.services.consumerQuotaMetrics.importAdminOverrides

Create or update multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

google_serviceusage.serviceusage.services.consumerQuotaMetrics.importAdminOverrides({
  "parent": ""
}, context)

Input

• input object
  • parent required string: The resource name of the consumer. An example name would be: projects/123/services/compute.googleapis.com
  • body ImportAdminOverridesRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.consumerQuotaMetrics.importConsumerOverrides

Create or update multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

google_serviceusage.serviceusage.services.consumerQuotaMetrics.importConsumerOverrides({
  "parent": ""
}, context)

Input

• input object
  • parent required string: The resource name of the consumer. An example name would be: projects/123/services/compute.googleapis.com
  • body ImportConsumerOverridesRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.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.

google_serviceusage.serviceusage.services.list({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Parent to search for services on. An example name would be: projects/123 where 123 is the project number (not project ID).
  • filter string: Only list services that conform to the given filter. The allowed filter strings are state:ENABLED and state:DISABLED.
  • pageSize integer: Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50.
  • pageToken string: Token identifying which result to start with, which is returned by a previous list call.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListServicesResponse

serviceusage.services.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. Operation

google_serviceusage.serviceusage.services.batchEnable({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Parent to enable services on. An example name would be: projects/123 where 123 is the project number (not project ID). The BatchEnableServices method currently only supports projects.
  • body BatchEnableServicesRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

serviceusage.services.generateServiceIdentity

Generate service identity for service.

google_serviceusage.serviceusage.services.generateServiceIdentity({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Name of the consumer and service to generate an identity for. The GenerateServiceIdentity methods currently only support projects. An example name would be: projects/123/services/example.googleapis.com where 123 is the project number.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

Definitions

AdminQuotaPolicy

• AdminQuotaPolicy object: Quota policy created by quota administrator.
  • container string: The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}
  • dimensions object: If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an 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.
  • metric string: The name of the metric to which this policy applies. An example name would be: compute.googleapis.com/cpus
  • name string: 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/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d
  • policyValue string: The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
  • unit string: 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.

Api

• Api object: 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.
  • methods array: The methods of this interface, in unspecified order.
    • items Method
  • mixins array: Included interfaces. See Mixin.
    • items Mixin
  • name string: The fully qualified name of this interface, including package name followed by the interface's simple name.
  • options array: Any metadata attached to the interface.
    • items Option
  • sourceContext SourceContext
  • syntax string (values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax of the service.
  • version string: 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 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.

AuthProvider

• AuthProvider object: Configuration for an authentication provider, including support for JSON Web Token (JWT).
  • audiences string: The list of JWT audiences. 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
  • authorizationUrl string: Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
  • id string: The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".
  • issuer string: 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
  • jwksUri string: URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
  • jwtLocations array: Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. 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
    • items JwtLocation

AuthRequirement

• AuthRequirement object: User-defined authentication requirements, including support for JSON Web Token (JWT).
  • audiences string: NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. 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.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
  • providerId string: id from authentication provider. Example: provider_id: bookstore_auth

Authentication

• Authentication object: Authentication defines the authentication configuration for an API. Example for an API targeted for external use: 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
  • providers array: Defines a set of authentication providers that a service supports.
    • items AuthProvider
  • rules array: A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
    • items AuthenticationRule

AuthenticationRule

• AuthenticationRule object: 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.
  • allowWithoutCredential boolean: If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
  • oauth OAuthRequirements
  • requirements array: Requirements for additional authentication providers.
    • items AuthRequirement
  • selector string: Selects the methods to which this rule applies. Refer to selector for syntax details.

Backend

• Backend object: Backend defines the backend configuration for a service.
  • rules array: A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
    • items BackendRule

BackendRule

• BackendRule object: A backend rule provides configuration for an individual API element.
  • address string: 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.
  • deadline number: The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
  • disableAuth boolean: 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.
  • jwtAudience string: 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.
  • minDeadline number: Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
  • operationDeadline number: The number of seconds to wait for the completion of a long running operation. The default is no deadline.
  • pathTranslation string (values: PATH_TRANSLATION_UNSPECIFIED, CONSTANT_ADDRESS, APPEND_PATH_TO_ADDRESS)
  • protocol string: 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.
  • selector string: Selects the methods to which this rule applies. Refer to selector for syntax details.

BatchCreateAdminOverridesResponse

• BatchCreateAdminOverridesResponse object: Response message for BatchCreateAdminOverrides
  • overrides array: The overrides that were created.
    • items QuotaOverride

BatchCreateConsumerOverridesResponse

• BatchCreateConsumerOverridesResponse object: Response message for BatchCreateConsumerOverrides
  • overrides array: The overrides that were created.
    • items QuotaOverride

BatchEnableServicesRequest

• BatchEnableServicesRequest object: Request message for the BatchEnableServices method.
  • serviceIds array: The identifiers of the services to enable on the project. A valid identifier would be: serviceusage.googleapis.com Enabling services requires that each service is public or is shared with the user enabling the service. Two or more services must be specified. To enable a single service, use the EnableService method instead. A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no state changes will occur.
    • items string

BatchEnableServicesResponse

• BatchEnableServicesResponse object: Response message for the BatchEnableServices method. This response message is assigned to the response field of the returned Operation when that operation is done.
  • failures array: If allow_partial_success is true, and one or more services could not be enabled, this field contains the details about each failure.
    • items EnableFailure
  • services array: The new state of the services after enabling.
    • items GoogleApiServiceusageV1Service

Billing

• Billing object: 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
  • consumerDestinations array: 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.
    • items BillingDestination

BillingDestination

• BillingDestination object: Configuration of a specific billing destination (Currently only support bill against consumer project).
  • metrics array: Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
    • items string
  • monitoredResource string: The monitored resource type. The type must be defined in Service.monitored_resources section.

ConsumerQuotaLimit

• ConsumerQuotaLimit object: Consumer quota settings for a quota limit.
  • allowsAdminOverrides boolean: Whether admin overrides are allowed on this limit
  • isPrecise boolean: Whether this limit is precise or imprecise.
  • metric string: The name of the parent metric of this limit. An example name would be: compute.googleapis.com/cpus
  • name string: The resource name of the quota limit. An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.
  • quotaBuckets array: Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).
    • items QuotaBucket
  • unit string: The limit unit. An example unit would be 1/{project}/{region} Note that {project} and {region} are not placeholders in this example; the literal characters { and } occur in the string.

ConsumerQuotaMetric

• ConsumerQuotaMetric object: Consumer quota settings for a quota metric.
  • consumerQuotaLimits array: The consumer quota for each quota limit defined on the metric.
    • items ConsumerQuotaLimit
  • displayName string: The display name of the metric. An example name would be: "CPUs"
  • metric string: The name of the metric. An example name would be: compute.googleapis.com/cpus
  • name string: The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.
  • unit string: The units in which the metric value is reported.

Context

• Context object: 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.
  • rules array: A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
    • items ContextRule

ContextRule

• ContextRule object: A context rule provides information about the context for an individual API element.
  • allowedRequestExtensions array: A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
    • items string
  • allowedResponseExtensions array: A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
    • items string
  • provided array: A list of full type names of provided contexts.
    • items string
  • requested array: A list of full type names of requested contexts.
    • items string
  • selector string: Selects the methods to which this rule applies. Refer to selector for syntax details.

Control

• Control object: Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.
  • environment string: The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.

CustomError

• CustomError object: 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
  • rules array: The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
    • items CustomErrorRule
  • types array: The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
    • items string

CustomErrorRule

• CustomErrorRule object: A custom error rule.
  • isErrorType boolean: Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
  • selector string: Selects messages to which this rule applies. Refer to selector for syntax details.

CustomHttpPattern

• CustomHttpPattern object: A custom pattern is used for defining custom HTTP verb.
  • kind string: The name of this custom HTTP verb.
  • path string: The path matched by this custom verb.

DisableServiceRequest

• DisableServiceRequest object: Request message for the DisableService method.

DisableServiceResponse

• DisableServiceResponse object: Response message for the DisableService method. This response message is assigned to the response field of the returned Operation when that operation is done.
  • service GoogleApiServiceusageV1Service

Documentation

• Documentation object: 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 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.
  • documentationRootUrl string: The URL to the root of documentation.
  • overview string: 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.
  • pages array: The top level pages for the documentation set.
    • items Page
  • rules array: A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
    • items DocumentationRule
  • serviceRootUrl string: 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.
  • summary string: A short summary of what the service does. Can only be provided by plain text.

DocumentationRule

• DocumentationRule object: A documentation rule provides information about individual API elements.
  • deprecationDescription string: Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.
  • description string: Description of the selected API(s).
  • selector string: The selector is a comma-separated list of patterns. 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.

Empty

• Empty object: 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); } The JSON representation for Empty is empty JSON object {}.

EnableFailure

• EnableFailure object: Provides error messages for the failing services.
  • errorMessage string: An error message describing why the service could not be enabled.
  • serviceId string: The service id of a service that could not be enabled.

EnableServiceRequest

• EnableServiceRequest object: Request message for the EnableService method.

EnableServiceResponse

• EnableServiceResponse object: Response message for the EnableService method. This response message is assigned to the response field of the returned Operation when that operation is done.
  • service GoogleApiServiceusageV1Service

Endpoint

• Endpoint object: Endpoint describes a network endpoint 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 service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true
  • aliases array: DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
    • items string
  • allowCors boolean: Allowing CORS, 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.
  • name string: The canonical name of this endpoint.
  • target string: The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

Enum

• Enum object: Enum type definition.
  • enumvalue array: Enum value definitions.
    • items EnumValue
  • name string: Enum type name.
  • options array: Protocol buffer options.
    • items Option
  • sourceContext SourceContext
  • syntax string (values: SYNTAX_PROTO2, SYNTAX_PROTO3): The source syntax.

EnumValue

• EnumValue object: Enum value definition.
  • name string: Enum value name.
  • number integer: Enum value number.
  • options array: Protocol buffer options.
    • items Option

Field

• Field object: A single field of a message type.
  • cardinality string (values: CARDINALITY_UNKNOWN, CARDINALITY_OPTIONAL, CARDINALITY_REQUIRED, CARDINALITY_REPEATED): The field cardinality.
  • defaultValue string: The string value of the default value of this field. Proto2 syntax only.
  • jsonName string: The field JSON name.
  • kind string (values: TYPE_UNKNOWN, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT64, TYPE_UINT64, TYPE_INT32, TYPE_FIXED64, TYPE_FIXED32, TYPE_BOOL, TYPE_STRING, TYPE_GROUP, TYPE_MESSAGE, TYPE_BYTES, TYPE_UINT32, TYPE_ENUM, TYPE_SFIXED32, TYPE_SFIXED64, TYPE_SINT32, TYPE_SINT64): The field type.
  • name string: The field name.
  • number integer: The field number.
  • oneofIndex integer: 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.
  • options array: The protocol buffer options.
    • items Option
  • packed boolean: Whether to use alternative packed wire representation.
  • typeUrl string: The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

GetServiceIdentityResponse

• GetServiceIdentityResponse object: Response message for getting service identity.
  • identity ServiceIdentity
  • state string (values: IDENTITY_STATE_UNSPECIFIED, ACTIVE): Service identity state.

GoogleApiService

• GoogleApiService object: Service is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the 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. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar 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
  • apis array: 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.
    • items Api
  • authentication Authentication
  • backend Backend
  • billing Billing
  • configVersion integer: Deprecated. The service config compiler always sets this field to 3.
  • context Context
  • control Control
  • customError CustomError
  • documentation Documentation
  • endpoints array: 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.
    • items Endpoint
  • enums array: 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. Example: enums: - name: google.someapi.v1.SomeEnum
    • items Enum
  • http Http
  • id string: 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.
  • logging Logging
  • logs array: Defines the logs used by this service.
    • items LogDescriptor
  • metrics array: Defines the metrics used by this service.
    • items MetricDescriptor
  • monitoredResources array: Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
    • items MonitoredResourceDescriptor
  • monitoring Monitoring
  • name string: 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.
  • producerProjectId string: The Google project that owns this service.
  • quota Quota
  • sourceInfo SourceInfo
  • systemParameters SystemParameters
  • systemTypes array: 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.
    • items Type
  • title string: The product title for this service.
  • types array: 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. Example: types: - name: google.protobuf.Int32
    • items Type
  • usage Usage

GoogleApiServiceusageV1OperationMetadata

• GoogleApiServiceusageV1OperationMetadata object: The operation metadata returned for the batchend services operation.
  • resourceNames array: The full name of the resources that this operation is directly associated with.
    • items string

GoogleApiServiceusageV1Service

• GoogleApiServiceusageV1Service object: A service that is available for use by the consumer.
  • config GoogleApiServiceusageV1ServiceConfig
  • name string: The resource name of the consumer and service