api: google.golang.org/api/serviceusage/v1 Index | Files

package serviceusage

import "google.golang.org/api/serviceusage/v1"

Package serviceusage provides access to the Service Usage API.

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

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 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 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 option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

serviceusage-gen.go

Constants

const (
    // View and manage your data across Google Cloud Platform services
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

    // View your data across Google Cloud Platform services
    CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"

    // Manage your Google API service configuration
    ServiceManagementScope = "https://www.googleapis.com/auth/service.management"
)

OAuth2 scopes used by this API.

type Api Uses

type Api struct {
    // 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 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<major-version>`, 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. "Methods") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Methods") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*Api) MarshalJSON Uses

func (s *Api) MarshalJSON() ([]byte, error)

type AuthProvider Uses

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, 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.librar
    // y.v1.LibraryService".
    //
    // 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#sec
    // tion-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-discove
    // ry-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"`

    // ForceSendFields is a list of field names (e.g. "Audiences") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

AuthProvider: Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-tok en-32).

func (*AuthProvider) MarshalJSON Uses

func (s *AuthProvider) MarshalJSON() ([]byte, error)

type AuthRequirement Uses

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.librar
    // y.v1.LibraryService".
    //
    // 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

AuthRequirement: User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-tok en-32).

func (*AuthRequirement) MarshalJSON Uses

func (s *AuthRequirement) MarshalJSON() ([]byte, error)

type Authentication Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Authentication: `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

func (*Authentication) MarshalJSON Uses

func (s *Authentication) MarshalJSON() ([]byte, error)

type AuthenticationRule Uses

type AuthenticationRule struct {
    // AllowWithoutCredential: If true, the service accepts API keys without
    // any other credential.
    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 values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any
    // field with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

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.

func (*AuthenticationRule) MarshalJSON Uses

func (s *AuthenticationRule) MarshalJSON() ([]byte, error)

type Backend Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*Backend) MarshalJSON Uses

func (s *Backend) MarshalJSON() ([]byte, error)

type BackendRule Uses

type BackendRule struct {
    // Address: The address of the API backend.
    Address string `json:"address,omitempty"`

    // Deadline: The number of seconds to wait for a response from a
    // request.  The default
    // deadline for gRPC is infinite (no deadline) and HTTP requests is 5
    // seconds.
    Deadline float64 `json:"deadline,omitempty"`

    // JwtAudience: The JWT audience is used when generating a JWT id token
    // for the backend.
    JwtAudience string `json:"jwtAudience,omitempty"`

    // MinDeadline: Minimum deadline in seconds needed for this method.
    // Calls having deadline
    // value lower than this will be rejected.
    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"`

    // 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"`

    // 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BackendRule: A backend rule provides configuration for an individual API element.

func (*BackendRule) MarshalJSON Uses

func (s *BackendRule) MarshalJSON() ([]byte, error)

func (*BackendRule) UnmarshalJSON Uses

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

type BatchCreateAdminOverridesResponse Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BatchCreateAdminOverridesResponse: Response message for BatchCreateAdminOverrides

func (*BatchCreateAdminOverridesResponse) MarshalJSON Uses

func (s *BatchCreateAdminOverridesResponse) MarshalJSON() ([]byte, error)

type BatchCreateConsumerOverridesResponse Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BatchCreateConsumerOverridesResponse: Response message for BatchCreateConsumerOverrides

func (*BatchCreateConsumerOverridesResponse) MarshalJSON Uses

func (s *BatchCreateConsumerOverridesResponse) MarshalJSON() ([]byte, error)

type BatchEnableServicesRequest Uses

type BatchEnableServicesRequest struct {
    // ServiceIds: The identifiers of the services to enable on the
    // project.
    //
    // A valid identifier would be:
    // serviceusage.googleapis.com
    //
    // Enabling services requires that each service is public or is shared
    // with
    // the user enabling the service.
    //
    // Two or more services must be specified. To enable a single
    // service,
    // use the `EnableService` method instead.
    //
    // A single request can enable a maximum of 20 services at a time. If
    // more
    // than 20 services are specified, the request will fail, and no state
    // changes
    // will occur.
    ServiceIds []string `json:"serviceIds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ServiceIds") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BatchEnableServicesRequest: Request message for the `BatchEnableServices` method.

func (*BatchEnableServicesRequest) MarshalJSON Uses

func (s *BatchEnableServicesRequest) MarshalJSON() ([]byte, error)

type BatchEnableServicesResponse Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*BatchEnableServicesResponse) MarshalJSON Uses

func (s *BatchEnableServicesResponse) MarshalJSON() ([]byte, error)

type Billing Uses

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 values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Billing: Billing related configuration of the service.

The following example shows how to configure monitored resources and metrics for billing:

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.
metrics:
- name: library.googleapis.com/book/borrowed_count
  metric_kind: DELTA
  value_type: INT64
billing:
  consumer_destinations:
  - monitored_resource: library.googleapis.com/branch
    metrics:
    - library.googleapis.com/book/borrowed_count

func (*Billing) MarshalJSON Uses

func (s *Billing) MarshalJSON() ([]byte, error)

type BillingDestination Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*BillingDestination) MarshalJSON Uses

func (s *BillingDestination) MarshalJSON() ([]byte, error)

type CancelOperationRequest Uses

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type Context Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Context: `Context` defines which contexts an API requests.

Example:

context:
  rules:
  - selector: "*"
    requested:
    - google.rpc.context.ProjectContext
    - google.rpc.context.OriginContext

The above specifies that all methods in 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 whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-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.

func (*Context) MarshalJSON Uses

func (s *Context) MarshalJSON() ([]byte, error)

type ContextRule Uses

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.
    Provided []string `json:"provided,omitempty"`

    // Requested: A list of full type names of requested contexts.
    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 values are omitted from API
    // requests. However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any
    // field with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

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

func (*ContextRule) MarshalJSON Uses

func (s *ContextRule) MarshalJSON() ([]byte, error)

type Control Uses

type Control struct {
    // Environment: The service control environment to use. If empty, no
    // control plane
    // feature (like quota and billing) will be enabled.
    Environment string `json:"environment,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Environment") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Control: Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.

func (*Control) MarshalJSON Uses

func (s *Control) MarshalJSON() ([]byte, error)

type CustomError Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*CustomError) MarshalJSON Uses

func (s *CustomError) MarshalJSON() ([]byte, error)

type CustomErrorRule Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CustomErrorRule: A custom error rule.

func (*CustomErrorRule) MarshalJSON Uses

func (s *CustomErrorRule) MarshalJSON() ([]byte, error)

type CustomHttpPattern Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*CustomHttpPattern) MarshalJSON Uses

func (s *CustomHttpPattern) MarshalJSON() ([]byte, error)

type DisableServiceRequest Uses

type DisableServiceRequest struct {
    // 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.
    // "DisableDependentServices") to unconditionally include in API
    // requests. By default, fields with empty values are omitted from API
    // requests. However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DisableDependentServices")
    // to include in API requests with the JSON null value. By default,
    // fields with empty values are omitted from API requests. However, any
    // field with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

DisableServiceRequest: Request message for the `DisableService` method.

func (*DisableServiceRequest) MarshalJSON Uses

func (s *DisableServiceRequest) MarshalJSON() ([]byte, error)

type DisableServiceResponse Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*DisableServiceResponse) MarshalJSON Uses

func (s *DisableServiceResponse) MarshalJSON() ([]byte, error)

type Documentation Uses

type Documentation struct {
    // DocumentationRootUrl: The URL to the root of documentation.
    DocumentationRootUrl string `json:"documentationRootUrl,omitempty"`

    // Overview: Declares a single overview page. For
    // example:
    // <pre><code>documentation:
    //   summary: ...
    //   overview: &#40;== include overview.md ==&#41;
    // </code></pre>
    // This is a shortcut for the following declaration (using pages
    // style):
    // <pre><code>documentation:
    //   summary: ...
    //   pages:
    //   - name: Overview
    //     content: &#40;== include overview.md ==&#41;
    // </code></pre>
    // 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"`

    // 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 summary of what the service does. Can only be
    // provided by
    // plain text.
    Summary string `json:"summary,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "DocumentationRootUrl") to unconditionally include in API requests.
    // By default, fields with empty values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DocumentationRootUrl") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Documentation: `Documentation` provides the information for describing a service.

Example: <pre><code>documentation:

summary: >
  The Google Calendar API gives access
  to most calendar features.
pages:
- name: Overview
  content: &#40;== include google/foo/overview.md ==&#41;
- name: Tutorial
  content: &#40;== include google/foo/tutorial.md ==&#41;
  subpages;
  - name: Java
    content: &#40;== include google/foo/tutorial_java.md ==&#41;
rules:
- selector: google.calendar.Calendar.Get
  description: >
    ...
- selector: google.calendar.Calendar.Put
  description: >
    ...

</code></pre> 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: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> T o override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre>

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: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> 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: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.

func (*Documentation) MarshalJSON Uses

func (s *Documentation) MarshalJSON() ([]byte, error)

type DocumentationRule Uses

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 API(s).
    Description string `json:"description,omitempty"`

    // Selector: 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.
    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 values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any
    // field with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

DocumentationRule: A documentation rule provides information about individual API elements.

func (*DocumentationRule) MarshalJSON Uses

func (s *DocumentationRule) MarshalJSON() ([]byte, error)

type Empty Uses

type Empty struct {
    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`
}

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);

}

The JSON representation for `Empty` is empty JSON object `{}`.

type EnableFailure Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

EnableFailure: Provides error messages for the failing services.

func (*EnableFailure) MarshalJSON Uses

func (s *EnableFailure) MarshalJSON() ([]byte, error)

type EnableServiceRequest Uses

type EnableServiceRequest struct {
}

EnableServiceRequest: Request message for the `EnableService` method.

type EnableServiceResponse Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*EnableServiceResponse) MarshalJSON Uses

func (s *EnableServiceResponse) MarshalJSON() ([]byte, error)

type Endpoint Uses

type Endpoint struct {
    // Aliases: 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.
    Aliases []string `json:"aliases,omitempty"`

    // AllowCors:
    // Allowing
    // [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sh
    // aring), 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"`

    // Features: The list of features enabled on this endpoint.
    Features []string `json:"features,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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Endpoint: `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration.

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

func (*Endpoint) MarshalJSON Uses

func (s *Endpoint) MarshalJSON() ([]byte, error)

type Enum Uses

type Enum struct {
    // 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 string `json:"syntax,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Enumvalue") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Enumvalue") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Enum: Enum type definition.

func (*Enum) MarshalJSON Uses

func (s *Enum) MarshalJSON() ([]byte, error)

type EnumValue Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

EnumValue: Enum value definition.

func (*EnumValue) MarshalJSON Uses

func (s *EnumValue) MarshalJSON() ([]byte, error)

type Field Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Field: A single field of a message type.

func (*Field) MarshalJSON Uses

func (s *Field) MarshalJSON() ([]byte, error)

type GoogleApiService Uses

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

    // 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: The semantic version of the service configuration. The
    // config version
    // affects the interpretation of the service configuration. For
    // example,
    // certain features are enabled by default for certain config
    // versions.
    // The latest config version is `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. 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. If empty, the server may choose
    // to
    // generate one instead. Must be no longer than 60 characters.
    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"`

    // 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.
    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. 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleApiService: `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

func (*GoogleApiService) MarshalJSON Uses

func (s *GoogleApiService) MarshalJSON() ([]byte, error)

type GoogleApiServiceusageV1OperationMetadata Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleApiServiceusageV1OperationMetadata: The operation metadata returned for the batchend services operation.

func (*GoogleApiServiceusageV1OperationMetadata) MarshalJSON Uses

func (s *GoogleApiServiceusageV1OperationMetadata) MarshalJSON() ([]byte, error)

type GoogleApiServiceusageV1Service Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*GoogleApiServiceusageV1Service) MarshalJSON Uses

func (s *GoogleApiServiceusageV1Service) MarshalJSON() ([]byte, error)

type GoogleApiServiceusageV1ServiceConfig Uses

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

    // 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleApiServiceusageV1ServiceConfig: The configuration of the service.

func (*GoogleApiServiceusageV1ServiceConfig) MarshalJSON Uses

func (s *GoogleApiServiceusageV1ServiceConfig) MarshalJSON() ([]byte, error)

type Http Uses

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 values are omitted from API
    // requests. However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any field with an empty value appearing
    // in NullFields will be sent to the server as null. It is an error if a
    // field in this list has a non-empty value. This may be used to include
    // null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*Http) MarshalJSON Uses

func (s *Http) MarshalJSON() ([]byte, error)

type HttpRule Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

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 | gRPC -----|----- `GET /v1/messages/123456` | `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 | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `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&param=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 | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `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 | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `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 | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `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/re ference/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/re ference/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.

Example:

http:
  rules:
    # Selects a gRPC method and applies HttpRule to it.
    - 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.

func (*HttpRule) MarshalJSON Uses

func (s *HttpRule) MarshalJSON() ([]byte, error)

type LabelDescriptor Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

LabelDescriptor: A description of a label.

func (*LabelDescriptor) MarshalJSON Uses

func (s *LabelDescriptor) MarshalJSON() ([]byte, error)

type ListOperationsResponse Uses

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

    // 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (*ListOperationsResponse) MarshalJSON Uses

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListServicesResponse Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListServicesResponse: Response message for the `ListServices` method.

func (*ListServicesResponse) MarshalJSON Uses

func (s *ListServicesResponse) MarshalJSON() ([]byte, error)

type LogDescriptor Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*LogDescriptor) MarshalJSON Uses

func (s *LogDescriptor) MarshalJSON() ([]byte, error)

type Logging Uses

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 values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

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

func (*Logging) MarshalJSON Uses

func (s *Logging) MarshalJSON() ([]byte, error)

type LoggingDestination Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*LoggingDestination) MarshalJSON Uses

func (s *LoggingDestination) MarshalJSON() ([]byte, error)

type Method Uses

type Method struct {
    // 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.
    //
    // Possible values:
    //   "SYNTAX_PROTO2" - Syntax `proto2`.
    //   "SYNTAX_PROTO3" - Syntax `proto3`.
    Syntax string `json:"syntax,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Name") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Method: Method represents a method of an API interface.

func (*Method) MarshalJSON Uses

func (s *Method) MarshalJSON() ([]byte, error)

type MetricDescriptor Uses

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.
    //   "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 whitelisted. 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"`

    // 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 unit in which the metric value is reported. It is only
    // applicable
    // if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`.
    // The
    // supported units are a subset of [The Unified Code for Units
    // of
    // Measure](http://unitsofmeasure.org/ucum.html) standard:
    //
    // **Basic units (UNIT)**
    //
    // * `bit`   bit
    // * `By`    byte
    // * `s`     second
    // * `min`   minute
    // * `h`     hour
    // * `d`     day
    //
    // **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)
    //
    // **Grammar**
    //
    // The grammar also includes these connectors:
    //
    // * `/`    division (as an infix operator, e.g. `1/s`).
    // * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
    //
    // 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` and is
    //    equivalent to `1` if it is used alone. For examples,
    //    `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
    // * `NAME` is a sequence of non-blank printable ASCII characters not
    //    containing '{' or '}'.
    // * `1` represents dimensionless value 1, such as in `1/s`.
    // * `%` represents dimensionless value 1/100, and annotates values
    // giving
    //    a percentage.
    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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*MetricDescriptor) MarshalJSON Uses

func (s *MetricDescriptor) MarshalJSON() ([]byte, error)

type MetricDescriptorMetadata Uses

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. Please use the MetricDescriptor.launch_stage
    // instead.
    // The launch stage of the metric definition.
    //
    // Possible values:
    //   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.
    //   "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 whitelisted. 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"`

    // ForceSendFields is a list of field names (e.g. "IngestDelay") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*MetricDescriptorMetadata) MarshalJSON Uses

func (s *MetricDescriptorMetadata) MarshalJSON() ([]byte, error)

type MetricRule Uses

type MetricRule struct {
    // MetricCosts: Metrics to update when the selected methods are called,
    // and the associated
    // cost applied to each metric.
    //
    // The key of the map is the metric name, and the values are the
    // amount
    // increased for the metric against which the quota limits are
    // defined.
    // The value must not be negative.
    MetricCosts map[string]string `json:"metricCosts,omitempty"`

    // Selector: Selects the methods to which this rule applies.
    //
    // Refer to selector for syntax details.
    Selector string `json:"selector,omitempty"`

    // ForceSendFields is a list of field names (e.g. "MetricCosts") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "MetricCosts") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*MetricRule) MarshalJSON Uses

func (s *MetricRule) MarshalJSON() ([]byte, error)

type Mixin Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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 inherting 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";

  }
  ...
}

func (*Mixin) MarshalJSON Uses

func (s *Mixin) MarshalJSON() ([]byte, error)

type MonitoredResourceDescriptor Uses

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.
    //   "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 whitelisted. 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.
    // The maximum length of this value is 256 characters.
    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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*MonitoredResourceDescriptor) MarshalJSON Uses

func (s *MonitoredResourceDescriptor) MarshalJSON() ([]byte, error)

type Monitoring Uses

type Monitoring struct {
    // ConsumerDestinations: Monitoring configurations for sending metrics
    // to the consumer project.
    // There can be multiple consumer destinations. A monitored resouce 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 resouce 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 values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

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/overdue_count` metric is only sent to the consumer 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.
metrics:
- name: library.googleapis.com/book/returned_count
  metric_kind: DELTA
  value_type: INT64
  labels:
  - key: /customer_id
- name: library.googleapis.com/book/overdue_count
  metric_kind: GAUGE
  value_type: INT64
  labels:
  - key: /customer_id
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/overdue_count

func (*Monitoring) MarshalJSON Uses

func (s *Monitoring) MarshalJSON() ([]byte, error)

type MonitoringDestination Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*MonitoringDestination) MarshalJSON Uses

func (s *MonitoringDestination) MarshalJSON() ([]byte, error)

type OAuthRequirements Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

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.

func (*OAuthRequirements) MarshalJSON Uses

func (s *OAuthRequirements) MarshalJSON() ([]byte, error)

type Operation Uses

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 response of the operation in case of success.
    // 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*Operation) MarshalJSON Uses

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationMetadata Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

OperationMetadata: The operation metadata returned for the batchend services operation.

func (*OperationMetadata) MarshalJSON Uses

func (s *OperationMetadata) MarshalJSON() ([]byte, error)

type OperationsCancelCall Uses

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

func (*OperationsCancelCall) Context Uses

func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsCancelCall) Do Uses

func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "serviceusage.operations.cancel" call. Exactly one of *Empty or error will be non-nil. 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 (*OperationsCancelCall) Fields Uses

func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsCancelCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type OperationsDeleteCall Uses

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

func (*OperationsDeleteCall) Context Uses

func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsDeleteCall) Do Uses

func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "serviceusage.operations.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*OperationsDeleteCall) Fields Uses

func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsDeleteCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type OperationsGetCall Uses

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

func (*OperationsGetCall) Context Uses

func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsGetCall) Do Uses

func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "serviceusage.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 (*OperationsGetCall) Fields Uses

func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsGetCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*OperationsGetCall) IfNoneMatch Uses

func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type OperationsListCall Uses

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

func (*OperationsListCall) Context Uses

func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsListCall) Do Uses

func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "serviceusage.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. 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 (*OperationsListCall) Fields Uses

func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsListCall) Filter Uses

func (c *OperationsListCall) Filter(filter string) *OperationsListCall

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

func (*OperationsListCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*OperationsListCall) IfNoneMatch Uses

func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OperationsListCall) Name Uses

func (c *OperationsListCall) Name(name string) *OperationsListCall

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

func (*OperationsListCall) PageSize Uses

func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall

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

func (*OperationsListCall) PageToken Uses

func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall

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

func (*OperationsListCall) Pages Uses

func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

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.

type OperationsService Uses

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

func NewOperationsService Uses

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Cancel Uses

func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall

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

func (*OperationsService) Delete Uses

func (r *OperationsService) Delete(name string) *OperationsDeleteCall

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

func (*OperationsService) Get Uses

func (r *OperationsService) Get(name string) *OperationsGetCall

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.

func (*OperationsService) List Uses

func (r *OperationsService) List() *OperationsListCall

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.

type Option Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Option: A protocol buffer option, which can be attached to a message, field, enumeration, etc.

func (*Option) MarshalJSON Uses

func (s *Option) MarshalJSON() ([]byte, error)

type Page Uses

type Page struct {
    // Content: The Markdown content of the page. You can use <code>&#40;==
    // include {path}
    // ==&#41;</code> to include content from a Markdown file.
    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:
    // <pre><code>pages:
    // - name: Tutorial
    //   content: &#40;== include tutorial.md ==&#41;
    //   subpages:
    //   - name: Java
    //     content: &#40;== include tutorial_java.md
    // ==&#41;
    // </code></pre>
    // 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*Page) MarshalJSON Uses

func (s *Page) MarshalJSON() ([]byte, error)

type Quota Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*Quota) MarshalJSON Uses

func (s *Quota) MarshalJSON() ([]byte, error)

type QuotaLimit Uses

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. Example:
    // "100s", "24h", "1d".
    // For duration longer than a day, only multiple of days is supported.
    // We
    // support only "100s" and "1d" for now. Additional support will be
    // added in
    // the future. "0" indicates indefinite duration.
    //
    // 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"`

    // Unit: Specify the unit of the quota limit. It uses the same syntax
    // as
    // Metric.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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*QuotaLimit) MarshalJSON Uses

func (s *QuotaLimit) MarshalJSON() ([]byte, error)

type QuotaOverride Uses

type QuotaOverride struct {
    // 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"`

    // 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.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrid
    // es/4a3f2c1d`
    // `projects/123/services/compute.googleapis.com/consumerQuo
    // taMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/con
    // sumerOverrides/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"`

    // ForceSendFields is a list of field names (e.g. "Dimensions") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Dimensions") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

QuotaOverride: A quota override

func (*QuotaOverride) MarshalJSON Uses

func (s *QuotaOverride) MarshalJSON() ([]byte, error)

type Service Uses

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    Operations *OperationsService

    Services *ServicesService
    // contains filtered or unexported fields
}

func New Uses

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

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 NewService Uses

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type ServicesBatchEnableCall Uses

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

func (*ServicesBatchEnableCall) Context Uses

func (c *ServicesBatchEnableCall) Context(ctx context.Context) *ServicesBatchEnableCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ServicesBatchEnableCall) Do Uses

func (c *ServicesBatchEnableCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "serviceusage.services.batchEnable" call. Exactly one of *Operation or error will be non-nil. 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 (*ServicesBatchEnableCall) Fields Uses

func (c *ServicesBatchEnableCall) Fields(s ...googleapi.Field) *ServicesBatchEnableCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ServicesBatchEnableCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ServicesDisableCall Uses

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

func (*ServicesDisableCall) Context Uses

func (c *ServicesDisableCall) Context(ctx context.Context) *ServicesDisableCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ServicesDisableCall) Do Uses

func (c *ServicesDisableCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "serviceusage.services.disable" call. Exactly one of *Operation or error will be non-nil. 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 (*ServicesDisableCall) Fields Uses

func (c *ServicesDisableCall) Fields(s ...googleapi.Field) *ServicesDisableCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ServicesDisableCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ServicesEnableCall Uses

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

func (*ServicesEnableCall) Context Uses

func (c *ServicesEnableCall) Context(ctx context.Context) *ServicesEnableCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ServicesEnableCall) Do Uses

func (c *ServicesEnableCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "serviceusage.services.enable" call. Exactly one of *Operation or error will be non-nil. 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 (*ServicesEnableCall) Fields Uses

func (c *ServicesEnableCall) Fields(s ...googleapi.Field) *ServicesEnableCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ServicesEnableCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ServicesGetCall Uses

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

func (*ServicesGetCall) Context Uses

func (c *ServicesGetCall) Context(ctx context.Context) *ServicesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ServicesGetCall) Do Uses

func (c *ServicesGetCall) Do(opts ...googleapi.CallOption) (*GoogleApiServiceusageV1Service, error)

Do executes the "serviceusage.services.get" call. Exactly one of *GoogleApiServiceusageV1Service or error will be non-nil. 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 (*ServicesGetCall) Fields Uses

func (c *ServicesGetCall) Fields(s ...googleapi.Field) *ServicesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ServicesGetCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ServicesGetCall) IfNoneMatch Uses

func (c *ServicesGetCall) IfNoneMatch(entityTag string) *ServicesGetCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ServicesListCall Uses

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

func (*ServicesListCall) Context Uses

func (c *ServicesListCall) Context(ctx context.Context) *ServicesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ServicesListCall) Do Uses

func (c *ServicesListCall) Do(opts ...googleapi.CallOption) (*ListServicesResponse, error)

Do executes the "serviceusage.services.list" call. Exactly one of *ListServicesResponse or error will be non-nil. 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 (*ServicesListCall) Fields Uses

func (c *ServicesListCall) Fields(s ...googleapi.Field) *ServicesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ServicesListCall) Filter Uses

func (c *ServicesListCall) Filter(filter string) *ServicesListCall

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 (*ServicesListCall) Header Uses

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ServicesListCall) IfNoneMatch Uses

func (c *ServicesListCall) IfNoneMatch(entityTag string) *ServicesListCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ServicesListCall) PageSize Uses

func (c *ServicesListCall) PageSize(pageSize int64) *ServicesListCall

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 (*ServicesListCall) PageToken Uses

func (c *ServicesListCall) PageToken(pageToken string) *ServicesListCall

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

func (*ServicesListCall) Pages Uses

func (c *ServicesListCall) Pages(ctx context.Context, f func(*ListServicesResponse) error) error

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.

type ServicesService Uses

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

func NewServicesService Uses

func NewServicesService(s *Service) *ServicesService

func (*ServicesService) BatchEnable Uses

func (r *ServicesService) BatchEnable(parent string, batchenableservicesrequest *BatchEnableServicesRequest) *ServicesBatchEnableCall

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.

func (*ServicesService) Disable Uses

func (r *ServicesService) Disable(name string, disableservicerequest *DisableServiceRequest) *ServicesDisableCall

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.

func (*ServicesService) Enable Uses

func (r *ServicesService) Enable(name string, enableservicerequest *EnableServiceRequest) *ServicesEnableCall

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

func (*ServicesService) Get Uses

func (r *ServicesService) Get(name string) *ServicesGetCall

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

func (*ServicesService) List Uses

func (r *ServicesService) List(parent string) *ServicesListCall

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.

type SourceContext Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*SourceContext) MarshalJSON Uses

func (s *SourceContext) MarshalJSON() ([]byte, error)

type SourceInfo Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

SourceInfo: Source information used to create a Service Config

func (*SourceInfo) MarshalJSON Uses

func (s *SourceInfo) MarshalJSON() ([]byte, error)

type Status Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*Status) MarshalJSON Uses

func (s *Status) MarshalJSON() ([]byte, error)

type SystemParameter Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*SystemParameter) MarshalJSON Uses

func (s *SystemParameter) MarshalJSON() ([]byte, error)

type SystemParameterRule Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*SystemParameterRule) MarshalJSON Uses

func (s *SystemParameterRule) MarshalJSON() ([]byte, error)

type SystemParameters Uses

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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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.

func (*SystemParameters) MarshalJSON Uses

func (s *SystemParameters) MarshalJSON() ([]byte, error)

type Type Uses

type Type struct {
    // 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 string `json:"syntax,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Fields") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Fields") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Type: A protocol buffer message type.

func (*Type) MarshalJSON Uses

func (s *Type) MarshalJSON() ([]byte, error)

type Usage Uses

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
    // <service.name>/<requirement-id>;
    // for example 'serviceusage.googleapis.com/billing-enabled'.
    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 values are omitted from API
    // requests. However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any field with an empty value appearing
    // in NullFields will be sent to the server as null. It is an error if a
    // field in this list has a non-empty value. This may be used to include
    // null fields in Patch requests.
    NullFields []string `json:"-"`
}

Usage: Configuration controlling usage of a service.

func (*Usage) MarshalJSON Uses

func (s *Usage) MarshalJSON() ([]byte, error)

type UsageRule Uses

type UsageRule struct {
    // AllowUnregisteredCalls: If true, the selected method allows
    // unregistered calls, e.g. calls
    // that don't identify any user or application.
    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 values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    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. However, any
    // field with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

UsageRule: Usage configuration rules for the service.

NOTE: Under development.

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). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls.

Example of an API that wants to allow unregistered calls for entire service.

usage:
  rules:
  - selector: "*"
    allow_unregistered_calls: true

Example of a method that wants to allow unregistered calls.

usage:
  rules:
  - selector:

"google.example.library.v1.LibraryService.CreateBook"

allow_unregistered_calls: true

func (*UsageRule) MarshalJSON Uses

func (s *UsageRule) MarshalJSON() ([]byte, error)

Package serviceusage imports 14 packages (graph) and is imported by 3 packages. Updated 2019-07-21. Refresh now. Tools for package owners.