serviceuser
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package serviceuser provides access to the Service User API.
For product documentation, see:https://cloud.google.com/service-management/
Creating a client¶
Usage example:
import "google.golang.org/api/serviceuser/v1"...ctx := context.Background()serviceuserService, err := serviceuser.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
serviceuserService, err := serviceuser.NewService(ctx, option.WithScopes(serviceuser.ServiceManagementScope))
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
serviceuserService, err := serviceuser.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, ...)serviceuserService, err := serviceuser.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seehttps://godoc.org/google.golang.org/api/option/ for details on options.
Index¶
- Constants
- type APIService
- type Api
- type AuthProvider
- type AuthRequirement
- type Authentication
- type AuthenticationRule
- type AuthorizationConfig
- type Backend
- type BackendRule
- type Billing
- type BillingDestination
- type Context
- type ContextRule
- type Control
- type CustomError
- type CustomErrorRule
- type CustomHttpPattern
- type DisableServiceRequest
- type Documentation
- type DocumentationRule
- type EnableServiceRequest
- type Endpoint
- type Enum
- type EnumValue
- type Experimental
- type Field
- type Http
- type HttpRule
- type LabelDescriptor
- type ListEnabledServicesResponse
- type LogDescriptor
- type Logging
- type LoggingDestination
- type Method
- type MetricDescriptor
- type MetricDescriptorMetadata
- type MetricRule
- type Mixin
- type MonitoredResourceDescriptor
- type Monitoring
- type MonitoringDestination
- type OAuthRequirements
- type Operation
- type OperationMetadata
- type Option
- type Page
- type ProjectsService
- type ProjectsServicesDisableCall
- func (c *ProjectsServicesDisableCall) Context(ctx context.Context) *ProjectsServicesDisableCall
- func (c *ProjectsServicesDisableCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsServicesDisableCall) Fields(s ...googleapi.Field) *ProjectsServicesDisableCall
- func (c *ProjectsServicesDisableCall) Header() http.Header
- type ProjectsServicesEnableCall
- func (c *ProjectsServicesEnableCall) Context(ctx context.Context) *ProjectsServicesEnableCall
- func (c *ProjectsServicesEnableCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsServicesEnableCall) Fields(s ...googleapi.Field) *ProjectsServicesEnableCall
- func (c *ProjectsServicesEnableCall) Header() http.Header
- type ProjectsServicesListCall
- func (c *ProjectsServicesListCall) Context(ctx context.Context) *ProjectsServicesListCall
- func (c *ProjectsServicesListCall) Do(opts ...googleapi.CallOption) (*ListEnabledServicesResponse, error)
- func (c *ProjectsServicesListCall) Fields(s ...googleapi.Field) *ProjectsServicesListCall
- func (c *ProjectsServicesListCall) Header() http.Header
- func (c *ProjectsServicesListCall) IfNoneMatch(entityTag string) *ProjectsServicesListCall
- func (c *ProjectsServicesListCall) PageSize(pageSize int64) *ProjectsServicesListCall
- func (c *ProjectsServicesListCall) PageToken(pageToken string) *ProjectsServicesListCall
- func (c *ProjectsServicesListCall) Pages(ctx context.Context, f func(*ListEnabledServicesResponse) error) error
- type ProjectsServicesService
- func (r *ProjectsServicesService) Disable(name string, disableservicerequest *DisableServiceRequest) *ProjectsServicesDisableCall
- func (r *ProjectsServicesService) Enable(name string, enableservicerequest *EnableServiceRequest) *ProjectsServicesEnableCall
- func (r *ProjectsServicesService) List(parent string) *ProjectsServicesListCall
- type PublishedService
- type Quota
- type QuotaLimit
- type SearchServicesResponse
- type Service
- type ServicesSearchCall
- func (c *ServicesSearchCall) Context(ctx context.Context) *ServicesSearchCall
- func (c *ServicesSearchCall) Do(opts ...googleapi.CallOption) (*SearchServicesResponse, error)
- func (c *ServicesSearchCall) Fields(s ...googleapi.Field) *ServicesSearchCall
- func (c *ServicesSearchCall) Header() http.Header
- func (c *ServicesSearchCall) IfNoneMatch(entityTag string) *ServicesSearchCall
- func (c *ServicesSearchCall) PageSize(pageSize int64) *ServicesSearchCall
- func (c *ServicesSearchCall) PageToken(pageToken string) *ServicesSearchCall
- func (c *ServicesSearchCall) Pages(ctx context.Context, f func(*SearchServicesResponse) error) error
- type ServicesService
- type SourceContext
- type SourceInfo
- type Status
- type Step
- type SystemParameter
- type SystemParameterRule
- type SystemParameters
- type Type
- type Usage
- type UsageRule
Constants¶
const (// View and manage your data across Google Cloud Platform servicesCloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"// View your data across Google Cloud Platform servicesCloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"// Manage your Google API service configurationServiceManagementScope = "https://www.googleapis.com/auth/service.management")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAPIService¶
type APIService struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsServiceServices *ServicesService// contains filtered or unexported fields} funcNewdeprecated
func New(client *http.Client) (*APIService,error)
New creates a new APIService. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶added inv0.5.0
func NewService(ctxcontext.Context, opts ...option.ClientOption) (*APIService,error)
NewService creates a new APIService.
typeApi¶
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.Namestring `json:"name,omitempty"`// Options: Any metadata attached to the interface.Options []*Option `json:"options,omitempty"`// SourceContext: Source context for the protocol buffer service// represented by this// message.SourceContext *SourceContext `json:"sourceContext,omitempty"`// Syntax: The source syntax of the service.//// Possible values:// "SYNTAX_PROTO2" - Syntax `proto2`.// "SYNTAX_PROTO3" - Syntax `proto3`.Syntaxstring `json:"syntax,omitempty"`// Version: A version string for this interface. If specified, must have// the form// `major-version.minor-version`, as in `1.10`. If the minor version// is// omitted, it defaults to zero. If the entire version field is empty,// the// major version is derived from the package name, as outlined below. If// the// field is not empty, the version in the package name will be verified// to be// consistent with what is provided here.//// The versioning schema uses [semantic// versioning](http://semver.org) where the major version// number// indicates a breaking change and the minor version an// additive,// non-breaking change. Both version numbers are signals to users// what to expect from different versions, and should be// carefully// chosen based on the product plan.//// The major version is also reflected in the package name of// the// interface, which must end in `v<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.//Versionstring `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 APIInterface.
Interfaces are also described as "protocol buffer services" in somecontexts,such as by the "service" keyword in a .proto file, but they aredifferentfrom API Services, which represent a concrete implementation of aninterfaceas opposed to simply a description of methods and bindings. They arealsosometimes simply referred to as "APIs" in other contexts, such as thename ofthis message itself. Seehttps://cloud.google.com/apis/design/glossary fordetailed terminology.
func (*Api)MarshalJSON¶
typeAuthProvider¶
type AuthProvider struct {// Audiences: The list of// JWT// [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-// token-32#section-4.1.3).// that are allowed to access. A JWT containing any of these audiences// will// be accepted. When this setting is absent, 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.comAudiencesstring `json:"audiences,omitempty"`// AuthorizationUrl: Redirect URL if JWT token is required but no// present or is expired.// Implement authorizationUrl of securityDefinitions in OpenAPI spec.AuthorizationUrlstring `json:"authorizationUrl,omitempty"`// Id: The unique identifier of the auth provider. It will be referred// to by// `AuthRequirement.provider_id`.//// Example: "bookstore_auth".Idstring `json:"id,omitempty"`// Issuer: Identifies the principal that issued the JWT.// See//https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#sec// tion-4.1.1// Usually a URL or an email address.//// Example:https://securetoken.google.com// Example: 1234567-compute@developer.gserviceaccount.comIssuerstring `json:"issuer,omitempty"`// JwksUri: URL of the provider's public key set to validate signature// of the JWT. See// [OpenID// Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#// ProviderMetadata).// Optional if the key set document:// - can be retrieved from// [OpenID// Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html//// of the issuer.// - can be inferred from the email domain of the issuer (e.g. a Google// service account).//// Example:https://www.googleapis.com/oauth2/v1/certsJwksUristring `json:"jwksUri,omitempty"`// 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 anthentication provider, includingsupport for[JSON Web Token(JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
func (*AuthProvider)MarshalJSON¶
func (s *AuthProvider) MarshalJSON() ([]byte,error)
typeAuthRequirement¶
type AuthRequirement struct {// Audiences: NOTE: This will be deprecated soon, once// AuthProvider.audiences is// implemented and accepted in all the runtime components.//// The list of// JWT// [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-// token-32#section-4.1.3).// that are allowed to access. A JWT containing any of these audiences// will// be accepted. When this setting is absent, only JWTs with// audience// "https://Service_name/API_name"// will be accepted. For example, if no audiences are in the// setting,// LibraryService API will only accept JWTs with the following// audience// "https://library-example.googleapis.com/google.example.librar// y.v1.LibraryService".//// Example://// audiences: bookstore_android.apps.googleusercontent.com,// bookstore_web.apps.googleusercontent.comAudiencesstring `json:"audiences,omitempty"`// ProviderId: id from authentication provider.//// Example://// provider_id: bookstore_authProviderIdstring `json:"providerId,omitempty"`// ForceSendFields is a list of field names (e.g. "Audiences") to// unconditionally include in API requests. By default, fields with// empty 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, includingsupport for[JSON Web Token(JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
func (*AuthRequirement)MarshalJSON¶
func (s *AuthRequirement) MarshalJSON() ([]byte,error)
typeAuthentication¶
type Authentication struct {// Providers: Defines a set of authentication providers that a service// supports.Providers []*AuthProvider `json:"providers,omitempty"`// Rules: A list of authentication rules that apply to individual API// methods.//// **NOTE:** All service configuration rules follow "last one wins"// order.Rules []*AuthenticationRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g. "Providers") to// unconditionally include in API requests. By default, fields with// empty 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 authenticationconfiguration for an API.
Example for an API targeted for external use:
name: calendar.googleapis.comauthentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth
func (*Authentication)MarshalJSON¶
func (s *Authentication) MarshalJSON() ([]byte,error)
typeAuthenticationRule¶
type AuthenticationRule struct {// AllowWithoutCredential: If true, the service accepts API keys without// any other credential.AllowWithoutCredentialbool `json:"allowWithoutCredential,omitempty"`// Oauth: The requirements for OAuth credentials.Oauth *OAuthRequirements `json:"oauth,omitempty"`// Requirements: Requirements for additional authentication providers.Requirements []*AuthRequirement `json:"requirements,omitempty"`// Selector: Selects the methods to which this rule applies.//// Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g.// "AllowWithoutCredential") to unconditionally include in API requests.// By default, fields with empty 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, everyrequestmust include a valid credential matching one of therequirements.It's an error to include more than one kind of credential in asinglerequest.
If a method doesn't have any auth requirements, request credentialswill beignored.
func (*AuthenticationRule)MarshalJSON¶
func (s *AuthenticationRule) MarshalJSON() ([]byte,error)
typeAuthorizationConfig¶
type AuthorizationConfig struct {// Provider: The name of the authorization provider, such// as// firebaserules.googleapis.com.Providerstring `json:"provider,omitempty"`// ForceSendFields is a list of field names (e.g. "Provider") 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. "Provider") 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:"-"`}AuthorizationConfig: Configuration of authorization.
This section determines the authorization provider, if unspecified,then noauthorization check will be done.
Example:
experimental: authorization: provider: firebaserules.googleapis.com
func (*AuthorizationConfig)MarshalJSON¶
func (s *AuthorizationConfig) MarshalJSON() ([]byte,error)
typeBackend¶
type Backend struct {// Rules: A list of API backend rules that apply to individual API// methods.//// **NOTE:** All service configuration rules follow "last one wins"// order.Rules []*BackendRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g. "Rules") to// unconditionally include in API requests. By default, fields with// empty 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¶
typeBackendRule¶
type BackendRule struct {// Address: The address of the API backend.Addressstring `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.Deadlinefloat64 `json:"deadline,omitempty"`// MinDeadline: Minimum deadline in seconds needed for this method.// Calls having deadline// value lower than this will be rejected.MinDeadlinefloat64 `json:"minDeadline,omitempty"`// Selector: Selects the methods to which this rule applies.//// Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "Address") to// unconditionally include in API requests. By default, fields with// empty 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 individualAPI element.
func (*BackendRule)MarshalJSON¶
func (s *BackendRule) MarshalJSON() ([]byte,error)
func (*BackendRule)UnmarshalJSON¶
func (s *BackendRule) UnmarshalJSON(data []byte)error
typeBilling¶
type Billing struct {// ConsumerDestinations: Billing configurations for sending metrics to// the consumer project.// There can be multiple consumer destinations per service, each one// must have// a different monitored resource type. A metric can be used in at// most// one consumer destination.ConsumerDestinations []*BillingDestination `json:"consumerDestinations,omitempty"`// ForceSendFields is a list of field names (e.g.// "ConsumerDestinations") to unconditionally include in API requests.// By default, fields with empty 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 andmetricsfor billing:
monitored_resources:- type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located
in.
- key: /namedescription: The name of the branch.metrics:
- name: library.googleapis.com/book/borrowed_countmetric_kind: DELTAvalue_type: INT64billing:consumer_destinations:
- monitored_resource: library.googleapis.com/branchmetrics:
- library.googleapis.com/book/borrowed_count
func (*Billing)MarshalJSON¶
typeBillingDestination¶
type BillingDestination struct {// Metrics: Names of the metrics to report to this billing// destination.// Each name must be defined in Service.metrics section.Metrics []string `json:"metrics,omitempty"`// MonitoredResource: The monitored resource type. The type must be// defined in// Service.monitored_resources section.MonitoredResourcestring `json:"monitoredResource,omitempty"`// ForceSendFields is a list of field names (e.g. "Metrics") to// unconditionally include in API requests. By default, fields with// empty 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 supportbill against consumer project).
func (*BillingDestination)MarshalJSON¶
func (s *BillingDestination) MarshalJSON() ([]byte,error)
typeContext¶
type Context struct {// Rules: A list of RPC context rules that apply to individual API// methods.//// **NOTE:** All service configuration rules follow "last one wins"// order.Rules []*ContextRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g. "Rules") to// unconditionally include in API requests. By default, fields with// empty 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 APIrequests.
Example:
context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext
The above specifies that all methods in the APIrequest`google.rpc.context.ProjectContext`and`google.rpc.context.OriginContext`.
Available context types are defined inpackage`google.rpc.context`.
This also provides mechanism to whitelist any protobuf messageextension thatcan be sent in grpc metadata using“x-goog-ext-<extension_id>-bin”and“x-goog-ext-<extension_id>-jspb” format. For example, list anyservicespecific protobuf types that can appear in grpc metadata as followsin youryaml file:
Example:
context: rules: - selector:
"google.example.library.v1.LibraryService.CreateBook"
allowed_request_extensions:- google.foo.v1.NewExtensionallowed_response_extensions:- google.foo.v1.NewExtension
You can also specify extension ID instead of fully qualifiedextension namehere.
func (*Context)MarshalJSON¶
typeContextRule¶
type ContextRule struct {// AllowedRequestExtensions: A list of full type names or extension IDs// of extensions allowed in grpc// side channel from client to backend.AllowedRequestExtensions []string `json:"allowedRequestExtensions,omitempty"`// AllowedResponseExtensions: A list of full type names or extension IDs// of extensions allowed in grpc// side channel from backend to client.AllowedResponseExtensions []string `json:"allowedResponseExtensions,omitempty"`// Provided: A list of full type names of provided contexts.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.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g.// "AllowedRequestExtensions") to unconditionally include in API// requests. By default, fields with empty 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 contextfor an individual APIelement.
func (*ContextRule)MarshalJSON¶
func (s *ContextRule) MarshalJSON() ([]byte,error)
typeControl¶
type Control struct {// Environment: The service control environment to use. If empty, no// control plane// feature (like quota and billing) will be enabled.Environmentstring `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 theservice. Theservice controller handles features like abuse, quota, billing,logging,monitoring, etc.
func (*Control)MarshalJSON¶
typeCustomError¶
type CustomError struct {// Rules: The list of custom error rules that apply to individual API// messages.//// **NOTE:** All service configuration rules follow "last one wins"// order.Rules []*CustomErrorRule `json:"rules,omitempty"`// Types: The list of custom error detail types, e.g.// 'google.foo.v1.CustomError'.Types []string `json:"types,omitempty"`// ForceSendFields is a list of field names (e.g. "Rules") to// unconditionally include in API requests. By default, fields with// empty 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, listany servicespecific protobuf types that can appear in error detail listsoferror responses.
Example:
custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError
func (*CustomError)MarshalJSON¶
func (s *CustomError) MarshalJSON() ([]byte,error)
typeCustomErrorRule¶
type CustomErrorRule struct {// IsErrorType: Mark this message as possible payload in error response.// Otherwise,// objects of this type will be filtered when they appear in error// payload.IsErrorTypebool `json:"isErrorType,omitempty"`// Selector: Selects messages to which this rule applies.//// Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "IsErrorType") to// unconditionally include in API requests. By default, fields with// empty 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¶
func (s *CustomErrorRule) MarshalJSON() ([]byte,error)
typeCustomHttpPattern¶
type CustomHttpPattern struct {// Kind: The name of this custom HTTP verb.Kindstring `json:"kind,omitempty"`// Path: The path matched by this custom verb.Pathstring `json:"path,omitempty"`// ForceSendFields is a list of field names (e.g. "Kind") to// unconditionally include in API requests. By default, fields with// empty 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 HTTPverb.
func (*CustomHttpPattern)MarshalJSON¶
func (s *CustomHttpPattern) MarshalJSON() ([]byte,error)
typeDisableServiceRequest¶
type DisableServiceRequest struct {}DisableServiceRequest: Request message for DisableService method.
typeDocumentation¶
type Documentation struct {// DocumentationRootUrl: The URL to the root of documentation.DocumentationRootUrlstring `json:"documentationRootUrl,omitempty"`// Overview: Declares a single overview page. For// example:// <pre><code>documentation:// summary: ...// overview: (== include overview.md ==)// </code></pre>// This is a shortcut for the following declaration (using pages// style):// <pre><code>documentation:// summary: ...// pages:// - name: Overview// content: (== include overview.md ==)// </code></pre>// Note: you cannot specify both `overview` field and `pages` field.Overviewstring `json:"overview,omitempty"`// Pages: The top level pages for the documentation set.Pages []*Page `json:"pages,omitempty"`// Rules: A list of documentation rules that apply to individual API// elements.//// **NOTE:** All service configuration rules follow "last one wins"// order.Rules []*DocumentationRule `json:"rules,omitempty"`// Summary: A short summary of what the service does. Can only be// provided by// plain text.Summarystring `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 fordescribing a service.
Example:<pre><code>documentation:
summary: > The Google Calendar API gives access to most calendar features.pages:- name: Overview content: (== include google/foo/overview.md ==)- name: Tutorial content: (== include google/foo/tutorial.md ==) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)rules:- selector: google.calendar.Calendar.Get description: > ...- selector: google.calendar.Calendar.Put description: > ...
</code></pre>Documentation is provided in markdown syntax. In addition tostandard markdown features, definition lists, tables and fencedcode blocks are supported. Section headers can be provided andareinterpreted relative to the section nesting of the context wherea documentation fragment is embedded.
Documentation from the IDL is merged with documentation definedvia the config at normalization time, where documentation providedby config rules overrides IDL provided.
A number of constructs specific to the API platform are supportedin documentation text.
In order to reference a proto element, the followingnotation can beused:<pre><code>[fully.qualified.proto.name][]</code></pre>To override the display text used for the link, this can beused:<pre><code>[displaytext][fully.qualified.proto.name]</code></pre>Text can be excluded from doc using the followingnotation:<pre><code>(-- internal comment --)</code></pre>
A few directives are available in documentation. Note thatdirectives must appear on a single line to be properlyidentified. The `include` directive includes a markdown file froman external source:<pre><code>(== include path/to/file ==)</code></pre>The `resource_for` directive marks a message to be the resource ofa collection in REST view. If it is not specified, tools attemptto infer the resource from the operations in acollection:<pre><code>(== resource_for v1.shelves.books==)</code></pre>The directive `suppress_warning` does not directly affectdocumentationand is documented together with service config validation.
func (*Documentation)MarshalJSON¶
func (s *Documentation) MarshalJSON() ([]byte,error)
typeDocumentationRule¶
type DocumentationRule struct {// DeprecationDescription: Deprecation description of the selected// element(s). It can be provided if an// element is marked as `deprecated`.DeprecationDescriptionstring `json:"deprecationDescription,omitempty"`// Description: Description of the selected API(s).Descriptionstring `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".// To// specify a default for all applicable elements, the whole pattern// "*"// is used.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g.// "DeprecationDescription") to unconditionally include in API requests.// By default, fields with empty 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 aboutindividual API elements.
func (*DocumentationRule)MarshalJSON¶
func (s *DocumentationRule) MarshalJSON() ([]byte,error)
typeEnableServiceRequest¶
type EnableServiceRequest struct {}EnableServiceRequest: Request message for EnableService method.
typeEndpoint¶
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.AllowCorsbool `json:"allowCors,omitempty"`// Features: The list of features enabled on this endpoint.Features []string `json:"features,omitempty"`// Name: The canonical name of this endpoint.Namestring `json:"name,omitempty"`// Target: The specification of an Internet routable address of API// frontend that will// handle requests to this [API// Endpoint](https://cloud.google.com/apis/design/glossary).// It should be either a valid IPv4 address or a fully-qualified domain// name.// For example, "8.8.8.8" or "myservice.appspot.com".Targetstring `json:"target,omitempty"`// ForceSendFields is a list of field names (e.g. "Aliases") to// unconditionally include in API requests. By default, fields with// empty 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 setof APIs.A service may expose any number of endpoints, and all endpoints sharethesame service configuration, such as quota configuration andmonitoringconfiguration.
Example service configuration:
name: library-example.googleapis.comendpoints: # 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¶
typeEnum¶
type Enum struct {// Enumvalue: Enum value definitions.Enumvalue []*EnumValue `json:"enumvalue,omitempty"`// Name: Enum type name.Namestring `json:"name,omitempty"`// Options: Protocol buffer options.Options []*Option `json:"options,omitempty"`// SourceContext: The source context.SourceContext *SourceContext `json:"sourceContext,omitempty"`// Syntax: The source syntax.//// Possible values:// "SYNTAX_PROTO2" - Syntax `proto2`.// "SYNTAX_PROTO3" - Syntax `proto3`.Syntaxstring `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¶
typeEnumValue¶
type EnumValue struct {// Name: Enum value name.Namestring `json:"name,omitempty"`// Number: Enum value number.Numberint64 `json:"number,omitempty"`// Options: Protocol buffer options.Options []*Option `json:"options,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to// unconditionally include in API requests. By default, fields with// empty 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¶
typeExperimental¶
type Experimental struct {// Authorization: Authorization configuration.Authorization *AuthorizationConfig `json:"authorization,omitempty"`// ForceSendFields is a list of field names (e.g. "Authorization") 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. "Authorization") 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:"-"`}Experimental: Experimental service configuration. These configurationoptions canonly be used by whitelisted users.
func (*Experimental)MarshalJSON¶
func (s *Experimental) MarshalJSON() ([]byte,error)
typeField¶
type Field struct {// Cardinality: The field cardinality.//// Possible values:// "CARDINALITY_UNKNOWN" - For fields with unknown cardinality.// "CARDINALITY_OPTIONAL" - For optional fields.// "CARDINALITY_REQUIRED" - For required fields. Proto2 syntax only.// "CARDINALITY_REPEATED" - For repeated fields.Cardinalitystring `json:"cardinality,omitempty"`// DefaultValue: The string value of the default value of this field.// Proto2 syntax only.DefaultValuestring `json:"defaultValue,omitempty"`// JsonName: The field JSON name.JsonNamestring `json:"jsonName,omitempty"`// Kind: The field type.//// Possible values:// "TYPE_UNKNOWN" - Field type unknown.// "TYPE_DOUBLE" - Field type double.// "TYPE_FLOAT" - Field type float.// "TYPE_INT64" - Field type int64.// "TYPE_UINT64" - Field type uint64.// "TYPE_INT32" - Field type int32.// "TYPE_FIXED64" - Field type fixed64.// "TYPE_FIXED32" - Field type fixed32.// "TYPE_BOOL" - Field type bool.// "TYPE_STRING" - Field type string.// "TYPE_GROUP" - Field type group. Proto2 syntax only, and// deprecated.// "TYPE_MESSAGE" - Field type message.// "TYPE_BYTES" - Field type bytes.// "TYPE_UINT32" - Field type uint32.// "TYPE_ENUM" - Field type enum.// "TYPE_SFIXED32" - Field type sfixed32.// "TYPE_SFIXED64" - Field type sfixed64.// "TYPE_SINT32" - Field type sint32.// "TYPE_SINT64" - Field type sint64.Kindstring `json:"kind,omitempty"`// Name: The field name.Namestring `json:"name,omitempty"`// Number: The field number.Numberint64 `json:"number,omitempty"`// OneofIndex: The index of the field type in `Type.oneofs`, for message// or enumeration// types. The first type has index 1; zero means the type is not in the// list.OneofIndexint64 `json:"oneofIndex,omitempty"`// Options: The protocol buffer options.Options []*Option `json:"options,omitempty"`// Packed: Whether to use alternative packed wire representation.Packedbool `json:"packed,omitempty"`// TypeUrl: The field type URL, without the scheme, for message or// enumeration// types. Example: "type.googleapis.com/google.protobuf.Timestamp".TypeUrlstring `json:"typeUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "Cardinality") to// unconditionally include in API requests. By default, fields with// empty 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¶
typeHttp¶
type Http struct {// FullyDecodeReservedExpansion: When set to true, URL path parmeters// will be fully URI-decoded except in// cases of single segment matches in reserved expansion, where "%2F"// will be// left encoded.//// The default behavior is to not decodeRFC 6570 reserved characters in// multi// segment matches.FullyDecodeReservedExpansionbool `json:"fullyDecodeReservedExpansion,omitempty"`// Rules: A list of HTTP configuration rules that apply to individual// API methods.//// **NOTE:** All service configuration rules follow "last one wins"// order.Rules []*HttpRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g.// "FullyDecodeReservedExpansion") to unconditionally include in API// requests. By default, fields with empty 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 containsa list ofHttpRule, each specifying the mapping of an RPC methodto one or more HTTP REST API methods.
func (*Http)MarshalJSON¶
typeHttpRule¶
type HttpRule struct {// AdditionalBindings: Additional HTTP bindings for the selector. Nested// bindings must// not contain an `additional_bindings` field themselves (that is,// the nesting may only be one level deep).AdditionalBindings []*HttpRule `json:"additionalBindings,omitempty"`// Body: The name of the request field whose value is mapped to the HTTP// request// body, or `*` for mapping all request fields not captured by the// path// pattern to the HTTP body, or omitted for not having any HTTP request// body.//// NOTE: the referred field must be present at the top-level of the// request// message type.Bodystring `json:"body,omitempty"`// Custom: The custom pattern is used for specifying an HTTP method that// is not// included in the `pattern` field, such as HEAD, or "*" to leave// the// HTTP method unspecified for this rule. The wild-card rule is// useful// for services that provide content to Web (HTML) clients.Custom *CustomHttpPattern `json:"custom,omitempty"`// Delete: Maps to HTTP DELETE. Used for deleting a resource.Deletestring `json:"delete,omitempty"`// Get: Maps to HTTP GET. Used for listing and getting information// about// resources.Getstring `json:"get,omitempty"`// Patch: Maps to HTTP PATCH. Used for updating a resource.Patchstring `json:"patch,omitempty"`// Post: Maps to HTTP POST. Used for creating a resource or performing// an action.Poststring `json:"post,omitempty"`// Put: Maps to HTTP PUT. Used for replacing a resource.Putstring `json:"put,omitempty"`// ResponseBody: Optional. The name of the response field whose value is// mapped to the HTTP// response body. When omitted, the entire response message will be// used// as the HTTP response body.//// NOTE: The referred field must be present at the top-level of the// response// message type.ResponseBodystring `json:"responseBody,omitempty"`// Selector: Selects a method to which this rule applies.//// Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "AdditionalBindings")// to unconditionally include in API requests. By default, fields with// empty 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 andone ormore HTTP REST endpoints. It allows developers to build a single APIservicethat supports both gRPC APIs and REST APIs. Many systems, including[GoogleAPIs](https://github.com/googleapis/googleapis),[Cloud Endpoints](https://cloud.google.com/endpoints),[gRPCGateway](https://github.com/grpc-ecosystem/grpc-gateway),and [Envoy](https://github.com/envoyproxy/envoy) proxy support thisfeatureand use it for large scale production services.
`HttpRule` defines the schema of the gRPC/REST mapping. The mappingspecifieshow different portions of the gRPC request message are mapped to theURLpath, URL query parameters, and HTTP request body. It also controlshow thegRPC response message is mapped to the HTTP response body. `HttpRule`istypically specified as an `google.api.http` annotation on the gRPCmethod.
Each mapping specifies a URL path template and an HTTP method. Thepathtemplate may refer to one or more fields in the gRPC request message,as longas each field is a non-repeated field with a primitive (non-message)type.The path template controls how fields of the request message aremapped tothe 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 pathtemplateautomatically become HTTP query parameters if there is no HTTPrequest 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 haveaprimitive type or a repeated primitive type or a non-repeated messagetype.In the case of a repeated type, the parameter can be repeated in theURLas `...?param=A¶m=B`. In the case of a message type, each fieldof themessage is mapped to a separate parameter, suchas`...?foo.a=A&foo.b=B&foo.c=C`.
For HTTP methods that allow a request body, the `body`fieldspecifies the mapping. Consider a REST update method on themessage 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, wheretherepresentation of the JSON in the request body is determinedbyprotos 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 definethatevery field not bound by the path template should be mapped totherequest body. This enables the following alternative definitionofthe 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 possibletohave HTTP parameters, as all fields not bound by the path end inthe body. This makes this option more rarely used in practicewhendefining REST APIs. The common usage of `*` is in custommethodswhich don't use the URL at all for transferring data.
It is possible to define multiple HTTP methods for one RPC byusingthe `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 RPCmappings:
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 therequest
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 `**`matcheszero or more URL path segments, which must be the last part of theURL pathexcept the `Verb`.
The syntax `Variable` matches part of the URL path as specified byitstemplate. A variable template must not contain other variables. If avariablematches 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 bepercent-encodedbefore 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 theclientside, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded.Theserver side does the reverse decoding. Such variables show up inthe[DiscoveryDocument](https://developers.google.com/discovery/v1/reference/apis)as `{var}`.
If a variable contains multiple path segments, such as"{var=foo/*}"or "{var=**}", when such a variable is expanded into a URL path ontheclient side, all characters except `[-_.~/0-9a-zA-Z]` arepercent-encoded.The server side does the reverse decoding, except "%2F" and "%2f" areleftunchanged. Such variables show up in the[DiscoveryDocument](https://developers.google.com/discovery/v1/reference/apis)as `{+var}`.
## Using gRPC API Service Configuration
gRPC API Service Configuration (service config) is a configurationlanguagefor configuring a gRPC service to become a user-facing product.Theservice config is simply the YAML representation of the`google.api.Service`proto message.
As an alternative to annotating your proto file, you can configuregRPCtranscoding in your service config YAML files. You do this byspecifying a`HttpRule` that maps the gRPC method to a REST endpoint, achievingthe sameeffect as the proto annotation. This can be particularly useful ifyouhave a proto that is reused in multiple services. Note that anytranscodingspecified in the service config will override any matchingtranscodingconfiguration 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,theproto to JSON conversion must follow the[proto3specification](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 SimpleStringExpansion, the multi segment variable **does not** followRFC 6570Section3.2.3 Reserved Expansion. The reason is that the ReservedExpansiondoes not expand special characters like `?` and `#`, which wouldleadto invalid URLs. As the result, gRPC Transcoding uses a customencodingfor multi segment variables.
The path variables **must not** refer to any repeated or mappedfield,because client libraries are not capable of handling such variableexpansion.
The path variables **must not** capture the leading "/" character.The reasonis that the most common use case "{var}" does not capture the leading"/"character. For consistency, all path variables must share the samebehavior.
Repeated message fields must not be mapped to URL query parameters,becauseno client library can support such complicated mapping.
If an API needs to use a JSON array for request or response body, itcan mapthe request or response body to a repeated field. However, somegRPCTranscoding implementations may not support this feature.
func (*HttpRule)MarshalJSON¶
typeLabelDescriptor¶
type LabelDescriptor struct {// Description: A human-readable description for the label.Descriptionstring `json:"description,omitempty"`// Key: The label key.Keystring `json:"key,omitempty"`// ValueType: The type of data that can be assigned to the label.//// Possible values:// "STRING" - A variable-length string. This is the default.// "BOOL" - Boolean; true or false.// "INT64" - A 64-bit signed integer.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with// empty 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¶
func (s *LabelDescriptor) MarshalJSON() ([]byte,error)
typeListEnabledServicesResponse¶
type ListEnabledServicesResponse struct {// NextPageToken: Token that can be passed to `ListEnabledServices` to// resume a paginated// query.NextPageTokenstring `json:"nextPageToken,omitempty"`// Services: Services enabled for the specified parent.Services []*PublishedService `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:"-"`}ListEnabledServicesResponse: Response message for`ListEnabledServices` method.
func (*ListEnabledServicesResponse)MarshalJSON¶
func (s *ListEnabledServicesResponse) MarshalJSON() ([]byte,error)
typeLogDescriptor¶
type LogDescriptor struct {// Description: A human-readable description of this log. This// information appears in// the documentation and can contain details.Descriptionstring `json:"description,omitempty"`// DisplayName: The human-readable name for this log. This information// appears on// the user interface and should be concise.DisplayNamestring `json:"displayName,omitempty"`// Labels: The set of labels that are available to describe a specific// log entry.// Runtime requests that contain labels not specified here// are// considered invalid.Labels []*LabelDescriptor `json:"labels,omitempty"`// Name: The name of the log. It must be less than 512 characters long// and can// include the following characters: upper- and lower-case// alphanumeric// characters [A-Za-z0-9], and punctuation characters including// slash, underscore, hyphen, period [/_-.].Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with// empty 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_historydescription: The history of borrowing and returning library
items.
display_name: Activitylabels:- key: /customer_id description: Identifier of a library customer
func (*LogDescriptor)MarshalJSON¶
func (s *LogDescriptor) MarshalJSON() ([]byte,error)
typeLogging¶
type Logging struct {// ConsumerDestinations: Logging configurations for sending logs to the// consumer project.// There can be multiple consumer destinations, each one must have// a// different monitored resource type. A log can be used in at most// one consumer destination.ConsumerDestinations []*LoggingDestination `json:"consumerDestinations,omitempty"`// ProducerDestinations: Logging configurations for sending logs to the// producer project.// There can be multiple producer destinations, each one must have// a// different monitored resource type. A log can be used in at most// one producer destination.ProducerDestinations []*LoggingDestination `json:"producerDestinations,omitempty"`// ForceSendFields is a list of field names (e.g.// "ConsumerDestinations") to unconditionally include in API requests.// By default, fields with empty 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 totheproducer and consumer projects. In the example, the`activity_history`log is sent to both the producer and consumer projects, whereasthe`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: /namedescription: The name of the branch.logs:
- name: activity_historylabels:
- key: /customer_id
- name: purchase_historylogging:producer_destinations:
- monitored_resource: library.googleapis.com/branchlogs:
- activity_history
- purchase_historyconsumer_destinations:
- monitored_resource: library.googleapis.com/branchlogs:
- activity_history
func (*Logging)MarshalJSON¶
typeLoggingDestination¶
type LoggingDestination struct {// Logs: Names of the logs to be sent to this destination. Each name// must// be defined in the Service.logs section. If the log name is// not a domain scoped name, it will be automatically prefixed with// the service name followed by "/".Logs []string `json:"logs,omitempty"`// MonitoredResource: The monitored resource type. The type must be// defined in the// Service.monitored_resources section.MonitoredResourcestring `json:"monitoredResource,omitempty"`// ForceSendFields is a list of field names (e.g. "Logs") to// unconditionally include in API requests. By default, fields with// empty 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 projector the consumer project).
func (*LoggingDestination)MarshalJSON¶
func (s *LoggingDestination) MarshalJSON() ([]byte,error)
typeMethod¶
type Method struct {// Name: The simple name of this method.Namestring `json:"name,omitempty"`// Options: Any metadata attached to the method.Options []*Option `json:"options,omitempty"`// RequestStreaming: If true, the request is streamed.RequestStreamingbool `json:"requestStreaming,omitempty"`// RequestTypeUrl: A URL of the input message type.RequestTypeUrlstring `json:"requestTypeUrl,omitempty"`// ResponseStreaming: If true, the response is streamed.ResponseStreamingbool `json:"responseStreaming,omitempty"`// ResponseTypeUrl: The URL of the output message type.ResponseTypeUrlstring `json:"responseTypeUrl,omitempty"`// Syntax: The source syntax of this method.//// Possible values:// "SYNTAX_PROTO2" - Syntax `proto2`.// "SYNTAX_PROTO3" - Syntax `proto3`.Syntaxstring `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¶
typeMetricDescriptor¶
type MetricDescriptor struct {// Description: A detailed description of the metric, which can be used// in documentation.Descriptionstring `json:"description,omitempty"`// DisplayName: A concise name for the metric, which can be displayed in// user interfaces.// Use sentence case without an ending period, for example "Request// count".// This field is optional but it is recommended to be set for any// metrics// associated with user-visible concepts, such as Quota.DisplayNamestring `json:"displayName,omitempty"`// Labels: The set of labels that can be used to describe a// specific// instance of this metric type. For example,// the// `appengine.googleapis.com/http/server/response_latencies` metric// type has a label for the HTTP response code, `response_code`, so// you can look at latencies for successful responses or just// for responses that failed.Labels []*LabelDescriptor `json:"labels,omitempty"`// Metadata: Optional. Metadata which can be used to guide usage of the// metric.Metadata *MetricDescriptorMetadata `json:"metadata,omitempty"`// MetricKind: Whether the metric records instantaneous values, changes// to a value, etc.// Some combinations of `metric_kind` and `value_type` might not be// supported.//// Possible values:// "METRIC_KIND_UNSPECIFIED" - Do not use this default value.// "GAUGE" - An instantaneous measurement of a value.// "DELTA" - The change in a value during a time interval.// "CUMULATIVE" - A value accumulated over a time interval.// Cumulative// measurements in a time series should have the same start time// and increasing end times, until an event resets the cumulative// value to zero and sets a new start time for the following// points.MetricKindstring `json:"metricKind,omitempty"`// Name: The resource name of the metric descriptor.Namestring `json:"name,omitempty"`// Type: The metric type, including its DNS name prefix. The type is// not// URL-encoded. All user-defined metric types have the DNS// name// `custom.googleapis.com` or `external.googleapis.com`. Metric types// should// use a natural hierarchical grouping. For example://// "custom.googleapis.com/invoice/paid/amount"// "external.googleapis.com/prometheus/up"// "appengine.googleapis.com/http/server/response_latencies"Typestring `json:"type,omitempty"`// Unit: The 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.Unitstring `json:"unit,omitempty"`// ValueType: Whether the measurement is an integer, a floating-point// number, etc.// Some combinations of `metric_kind` and `value_type` might not be// supported.//// Possible values:// "VALUE_TYPE_UNSPECIFIED" - Do not use this default value.// "BOOL" - The value is a boolean.// This value type can be used only if the metric kind is `GAUGE`.// "INT64" - The value is a signed 64-bit integer.// "DOUBLE" - The value is a double precision floating point number.// "STRING" - The value is a text string.// This value type can be used only if the metric kind is `GAUGE`.// "DISTRIBUTION" - The value is a `Distribution`.// "MONEY" - The value is money.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with// empty 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 metricdescriptor is created,deleting or altering it stops data collection and makes the metrictype'sexisting data unusable.
func (*MetricDescriptor)MarshalJSON¶
func (s *MetricDescriptor) MarshalJSON() ([]byte,error)
typeMetricDescriptorMetadata¶
type MetricDescriptorMetadata struct {// IngestDelay: The delay of data points caused by ingestion. Data// points older than this// age are guaranteed to be ingested and available to be read,// excluding// data loss due to errors.IngestDelaystring `json:"ingestDelay,omitempty"`// LaunchStage: 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.LaunchStagestring `json:"launchStage,omitempty"`// SamplePeriod: The sampling period of metric data points. For metrics// which are written// periodically, consecutive data points are stored at this time// interval,// excluding data loss due to errors. Metrics with a higher granularity// have// a smaller sampling period.SamplePeriodstring `json:"samplePeriod,omitempty"`// 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 toguide the usage of a metric.
func (*MetricDescriptorMetadata)MarshalJSON¶
func (s *MetricDescriptorMetadata) MarshalJSON() ([]byte,error)
typeMetricRule¶
type MetricRule struct {// MetricCosts: Metrics to update when the selected methods are called,// and the associated// cost applied to each metric.//// The key of the map is the metric name, and the values are the// amount// increased for the metric against which the quota limits are// defined.// The value must not be negative.MetricCosts map[string]string `json:"metricCosts,omitempty"`// Selector: Selects the methods to which this rule applies.//// Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "MetricCosts") to// unconditionally include in API requests. By default, fields with// empty 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 metriccauses thatmetric's configured quota behaviors to apply to the method call.
func (*MetricRule)MarshalJSON¶
func (s *MetricRule) MarshalJSON() ([]byte,error)
typeMixin¶
type Mixin struct {// Name: The fully qualified name of the interface which is included.Namestring `json:"name,omitempty"`// Root: If non-empty specifies a path under which inherited HTTP// paths// are rooted.Rootstring `json:"root,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to// unconditionally include in API requests. By default, fields with// empty 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 includinginterface must redeclare all the methods from the included interface,butdocumentation and options are inherited as follows:
If after comment and whitespace stripping, the documentationstring of the redeclared method is empty, it will be inheritedfrom the original method.
Each annotation belonging to the service config (http,visibility) which is not set in the redeclared method will beinherited.
If an http annotation is inherited, the path pattern will bemodified as follows. Any version prefix will be replaced by theversion of the including interface plus the root path ifspecified.
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`arealso declared with same name and request/response types in`Storage`. A documentation generator or annotation processor willsee the effective `Storage.GetAcl` method afterinhertingdocumentation 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 bearelative 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¶
typeMonitoredResourceDescriptor¶
type MonitoredResourceDescriptor struct {// Description: Optional. A detailed description of the monitored// resource type that might// be used in documentation.Descriptionstring `json:"description,omitempty"`// DisplayName: Optional. A concise name for the monitored resource type// that might be// displayed in user interfaces. It should be a Title Cased Noun// Phrase,// without any article or other determiners. For example,// "Google Cloud SQL Database".DisplayNamestring `json:"displayName,omitempty"`// Labels: Required. A set of labels used to describe instances of this// monitored// resource type. For example, an individual Google Cloud SQL database// is// identified by values for the labels "database_id" and "zone".Labels []*LabelDescriptor `json:"labels,omitempty"`// Name: Optional. The resource name of the monitored resource// descriptor:// "projects/{project_id}/monitoredResourceDescriptors/{type// }" where// {type} is the value of the `type` field in this object// and// {project_id} is a project ID that provides API-specific context// for// accessing the type. APIs that do not use project information can use// the// resource name format "monitoredResourceDescriptors/{type}".Namestring `json:"name,omitempty"`// Type: Required. The monitored resource type. For example, the// type// "cloudsql_database" represents databases in Google Cloud SQL.// The maximum length of this value is 256 characters.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with// empty 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 aMonitoredResource object using atype name and a set of labels. For example, the monitoredresourcedescriptor for Google Compute Engine VM instances has a typeof"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. APIsgenerallyprovide a `list` method that returns the monitored resourcedescriptors usedby the API.
func (*MonitoredResourceDescriptor)MarshalJSON¶
func (s *MonitoredResourceDescriptor) MarshalJSON() ([]byte,error)
typeMonitoring¶
type Monitoring struct {// ConsumerDestinations: Monitoring configurations for sending metrics// to the consumer project.// There can be multiple consumer destinations, each one must have// a// different monitored resource type. A metric can be used in at// most// one consumer destination.ConsumerDestinations []*MonitoringDestination `json:"consumerDestinations,omitempty"`// ProducerDestinations: Monitoring configurations for sending metrics// to the producer project.// There can be multiple producer destinations, each one must have// a// different monitored resource type. A metric can be used in at// most// one producer destination.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 andmetricsfor monitoring. In the example, a monitored resource and two metricsaredefined. The `library.googleapis.com/book/returned_count` metric issentto both producer and consumer projects, whereasthe`library.googleapis.com/book/overdue_count` metric is only sent totheconsumer project.
monitored_resources:- type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located
in.
- key: /namedescription: The name of the branch.metrics:
- name: library.googleapis.com/book/returned_countmetric_kind: DELTAvalue_type: INT64labels:
- key: /customer_id
- name: library.googleapis.com/book/overdue_countmetric_kind: GAUGEvalue_type: INT64labels:
- key: /customer_idmonitoring:producer_destinations:
- monitored_resource: library.googleapis.com/branchmetrics:
- library.googleapis.com/book/returned_countconsumer_destinations:
- monitored_resource: library.googleapis.com/branchmetrics:
- library.googleapis.com/book/returned_count
- library.googleapis.com/book/overdue_count
func (*Monitoring)MarshalJSON¶
func (s *Monitoring) MarshalJSON() ([]byte,error)
typeMonitoringDestination¶
type MonitoringDestination struct {// Metrics: Names of the metrics to report to this monitoring// destination.// Each name must be defined in Service.metrics section.Metrics []string `json:"metrics,omitempty"`// MonitoredResource: The monitored resource type. The type must be// defined in// Service.monitored_resources section.MonitoredResourcestring `json:"monitoredResource,omitempty"`// ForceSendFields is a list of field names (e.g. "Metrics") to// unconditionally include in API requests. By default, fields with// empty 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 monitoringdestination (the producer projector the consumer project).
func (*MonitoringDestination)MarshalJSON¶
func (s *MonitoringDestination) MarshalJSON() ([]byte,error)
typeOAuthRequirements¶
type OAuthRequirements struct {// CanonicalScopes: The list of publicly documented OAuth scopes that// are allowed access. An// OAuth token containing any of these scopes will be// accepted.//// Example://// canonical_scopes:https://www.googleapis.com/auth/calendar,//https://www.googleapis.com/auth/calendar.readCanonicalScopesstring `json:"canonicalScopes,omitempty"`// ForceSendFields is a list of field names (e.g. "CanonicalScopes") to// unconditionally include in API requests. By default, fields with// empty 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 andpermissions 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 anapplication,giving it permission to access that data on their behalf.
OAuth scope specifications should be fairly coarse grained; a userwill needto see and understand the text description of what your scopemeans.
In most cases: use one or at most two OAuth scopes for an entirefamily ofproducts. If your product has multiple APIs, you should probably besharingthe OAuth scope across all of those APIs.
When you need finer grained OAuth consent screens: talk with yourproductmanagement about how developers will use them in practice.
Please note that even though each of the canonical scopes is enoughfor arequest to be accepted and passed to the backend, a request can stillfaildue to the backend requiring additional scopes or permissions.
func (*OAuthRequirements)MarshalJSON¶
func (s *OAuthRequirements) MarshalJSON() ([]byte,error)
typeOperation¶
type Operation struct {// Done: If the value is `false`, it means the operation is still in// progress.// If `true`, the operation is completed, and either `error` or// `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or// cancellation.Error *Status `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation.// It typically// contains progress information and common metadata such as create// time.// Some services might not provide such metadata. Any method that// returns a// long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same// service that// originally returns it. If you use the default HTTP mapping,// the// `name` should have the format of `operations/some/unique/name`.Namestring `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`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to// unconditionally include in API requests. By default, fields with// empty 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 isthe result of anetwork API call.
func (*Operation)MarshalJSON¶
typeOperationMetadata¶
type OperationMetadata struct {// ProgressPercentage: Percentage of completion of this operation,// ranging from 0 to 100.ProgressPercentageint64 `json:"progressPercentage,omitempty"`// ResourceNames: The full name of the resources that this operation is// directly// associated with.ResourceNames []string `json:"resourceNames,omitempty"`// StartTime: The start time of the operation.StartTimestring `json:"startTime,omitempty"`// Steps: Detailed status information for each step. The order is// undetermined.Steps []*Step `json:"steps,omitempty"`// ForceSendFields is a list of field names (e.g. "ProgressPercentage")// 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. "ProgressPercentage") 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 metadata associated with a long runningoperation resource.
func (*OperationMetadata)MarshalJSON¶
func (s *OperationMetadata) MarshalJSON() ([]byte,error)
typeOption¶
type Option struct {// Name: The option's name. For protobuf built-in options (options// defined in// descriptor.proto), this is the short name. For example,// "map_entry".// For custom options, it should be the fully-qualified name. For// example,// "google.api.http".Namestring `json:"name,omitempty"`// Value: The option's value packed in an Any message. If the value is a// primitive,// the corresponding wrapper type defined in// google/protobuf/wrappers.proto// should be used. If the value is an enum, it should be stored as an// int32// value using the google.protobuf.Int32Value type.Valuegoogleapi.RawMessage `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to// unconditionally include in API requests. By default, fields with// empty 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¶
typePage¶
type Page struct {// Content: The Markdown content of the page. You can use <code>(==// include {path} ==)</code>// to include content from a Markdown file.Contentstring `json:"content,omitempty"`// Name: The name of the page. It will be used as an identity of the// page to// generate URI of the page, text of the link to this page in// navigation,// etc. The full page name (start from the root page name to this// page// concatenated with `.`) can be used as reference to the page in// your// documentation. For example:// <pre><code>pages:// - name: Tutorial// content: (== include tutorial.md ==)// subpages:// - name: Java// content: (== include tutorial_java.md// ==)// </code></pre>// You can reference `Java` page using Markdown reference link// syntax:// `Java`.Namestring `json:"name,omitempty"`// Subpages: Subpages of this page. The order of subpages specified here// will be// honored in the generated docset.Subpages []*Page `json:"subpages,omitempty"`// ForceSendFields is a list of field names (e.g. "Content") to// unconditionally include in API requests. By default, fields with// empty 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 torepresentnested documentation set structure.
func (*Page)MarshalJSON¶
typeProjectsService¶
type ProjectsService struct {Services *ProjectsServicesService// contains filtered or unexported fields}funcNewProjectsService¶
func NewProjectsService(s *APIService) *ProjectsService
typeProjectsServicesDisableCall¶
type ProjectsServicesDisableCall struct {// contains filtered or unexported fields}func (*ProjectsServicesDisableCall)Context¶
func (c *ProjectsServicesDisableCall) Context(ctxcontext.Context) *ProjectsServicesDisableCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*ProjectsServicesDisableCall)Do¶
func (c *ProjectsServicesDisableCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "serviceuser.projects.services.disable" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.
func (*ProjectsServicesDisableCall)Fields¶
func (c *ProjectsServicesDisableCall) Fields(s ...googleapi.Field) *ProjectsServicesDisableCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*ProjectsServicesDisableCall)Header¶
func (c *ProjectsServicesDisableCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
typeProjectsServicesEnableCall¶
type ProjectsServicesEnableCall struct {// contains filtered or unexported fields}func (*ProjectsServicesEnableCall)Context¶
func (c *ProjectsServicesEnableCall) Context(ctxcontext.Context) *ProjectsServicesEnableCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*ProjectsServicesEnableCall)Do¶
func (c *ProjectsServicesEnableCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "serviceuser.projects.services.enable" call.Exactly one of *Operation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.
func (*ProjectsServicesEnableCall)Fields¶
func (c *ProjectsServicesEnableCall) Fields(s ...googleapi.Field) *ProjectsServicesEnableCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*ProjectsServicesEnableCall)Header¶
func (c *ProjectsServicesEnableCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
typeProjectsServicesListCall¶
type ProjectsServicesListCall struct {// contains filtered or unexported fields}func (*ProjectsServicesListCall)Context¶
func (c *ProjectsServicesListCall) Context(ctxcontext.Context) *ProjectsServicesListCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*ProjectsServicesListCall)Do¶
func (c *ProjectsServicesListCall) Do(opts ...googleapi.CallOption) (*ListEnabledServicesResponse,error)
Do executes the "serviceuser.projects.services.list" call.Exactly one of *ListEnabledServicesResponse or error will be non-nil.Any non-2xx status code is an error. Response headers are in either*ListEnabledServicesResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.
func (*ProjectsServicesListCall)Fields¶
func (c *ProjectsServicesListCall) Fields(s ...googleapi.Field) *ProjectsServicesListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*ProjectsServicesListCall)Header¶
func (c *ProjectsServicesListCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
func (*ProjectsServicesListCall)IfNoneMatch¶
func (c *ProjectsServicesListCall) IfNoneMatch(entityTagstring) *ProjectsServicesListCall
IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.
func (*ProjectsServicesListCall)PageSize¶
func (c *ProjectsServicesListCall) PageSize(pageSizeint64) *ProjectsServicesListCall
PageSize sets the optional parameter "pageSize": Requested size ofthe next page of data.
func (*ProjectsServicesListCall)PageToken¶
func (c *ProjectsServicesListCall) PageToken(pageTokenstring) *ProjectsServicesListCall
PageToken sets the optional parameter "pageToken": Token identifyingwhich result to start with; returned by a previous listcall.
func (*ProjectsServicesListCall)Pages¶
func (c *ProjectsServicesListCall) Pages(ctxcontext.Context, f func(*ListEnabledServicesResponse)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.
typeProjectsServicesService¶
type ProjectsServicesService struct {// contains filtered or unexported fields}funcNewProjectsServicesService¶
func NewProjectsServicesService(s *APIService) *ProjectsServicesService
func (*ProjectsServicesService)Disable¶
func (r *ProjectsServicesService) Disable(namestring, disableservicerequest *DisableServiceRequest) *ProjectsServicesDisableCall
Disable: Disable a service so it can no longer be used withaproject. This prevents unintended usage that may cause unexpectedbillingcharges or security leaks.
Operation<response: google.protobuf.Empty>
func (*ProjectsServicesService)Enable¶
func (r *ProjectsServicesService) Enable(namestring, enableservicerequest *EnableServiceRequest) *ProjectsServicesEnableCall
Enable: Enable a service so it can be used with a project.See [Cloud Auth Guide](https://cloud.google.com/docs/authentication)formore information.
Operation<response: google.protobuf.Empty>
func (*ProjectsServicesService)List¶
func (r *ProjectsServicesService) List(parentstring) *ProjectsServicesListCall
List: List enabled services for the specified consumer.
typePublishedService¶
type PublishedService struct {// Name: The resource name of the service.//// A valid name would be:// - services/serviceuser.googleapis.comNamestring `json:"name,omitempty"`// Service: The service's published configuration.Service *Service `json:"service,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:"-"`}PublishedService: The published version of a Service that is managedbyGoogle Service Management.
func (*PublishedService)MarshalJSON¶
func (s *PublishedService) MarshalJSON() ([]byte,error)
typeQuota¶
type Quota struct {// Limits: List of `QuotaLimit` definitions for the service.Limits []*QuotaLimit `json:"limits,omitempty"`// MetricRules: List of `MetricRule` definitions, each one mapping a// selected method to one// or more metrics.MetricRules []*MetricRule `json:"metricRules,omitempty"`// ForceSendFields is a list of field names (e.g. "Limits") to// unconditionally include in API requests. By default, fields with// empty 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 inserviceusage.
The quota configuration works this way:
- The service configuration defines a set of metrics.
- For API calls, the quota.metric_rules maps methods to metrics withcorresponding 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 twomethods
# 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: 1Corresponding 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¶
typeQuotaLimit¶
type QuotaLimit struct {// DefaultLimit: Default number of tokens that can be consumed during// the specified// duration. This is the number of tokens assigned when a// client// application developer activates the service for his/her// project.//// Specifying a value of 0 will block all requests. This can be used if// you// are provisioning quota to selected consumers and blocking// others.// Similarly, a value of -1 will indicate an unlimited quota. No// other// negative values are allowed.//// Used by group-based quotas only.DefaultLimitint64 `json:"defaultLimit,omitempty,string"`// Description: Optional. User-visible, extended description for this// quota limit.// Should be used only when more context is needed to understand this// limit// than provided by the limit's display name (see: `display_name`).Descriptionstring `json:"description,omitempty"`// DisplayName: User-visible display name for this limit.// Optional. If not set, the UI will provide a default display name// based on// the quota configuration. This field can be used to override the// default// display name generated from the configuration.DisplayNamestring `json:"displayName,omitempty"`// Duration: Duration of this limit in textual notation. 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.Durationstring `json:"duration,omitempty"`// FreeTier: Free tier value displayed in the Developers Console for// this limit.// The free tier is the number of tokens that will be subtracted from// the// billed amount when billing is enabled.// This field can only be set on a limit with duration "1d", in a// billable// group; it is invalid on any other limit. If this field is not set,// it// defaults to 0, indicating that there is no free tier for this// service.//// Used by group-based quotas only.FreeTierint64 `json:"freeTier,omitempty,string"`// MaxLimit: Maximum number of tokens that can be consumed during the// specified// duration. Client application developers can override the default// limit up// to this maximum. If specified, this value cannot be set to a value// less// than the default limit. If not specified, it is set to the default// limit.//// To allow clients to apply overrides with no upper bound, set this to// -1,// indicating unlimited maximum quota.//// Used by group-based quotas only.MaxLimitint64 `json:"maxLimit,omitempty,string"`// Metric: The name of the metric this quota limit applies to. The quota// limits with// the same metric will be checked together during runtime. The metric// must be// defined within the service config.Metricstring `json:"metric,omitempty"`// Name: Name of the quota limit.//// The name must be provided, and it must be unique within the service.// The// name can only include alphanumeric characters as well as '-'.//// The maximum length of the limit name is 64 characters.Namestring `json:"name,omitempty"`// Unit: Specify the unit of the quota limit. It uses the same syntax// as// 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.Unitstring `json:"unit,omitempty"`// Values: Tiered limit values. You must specify this as a key:value// pair, with an// integer value that is the maximum number of requests allowed for// the// specified unit. Currently only STANDARD is supported.Values map[string]string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "DefaultLimit") to// unconditionally include in API requests. By default, fields with// empty 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 aspecified durationfor a limit type. There can be at most one limit for a duration andlimittype combination defined within a `QuotaGroup`.
func (*QuotaLimit)MarshalJSON¶
func (s *QuotaLimit) MarshalJSON() ([]byte,error)
typeSearchServicesResponse¶
type SearchServicesResponse struct {// NextPageToken: Token that can be passed to `ListAvailableServices` to// resume a paginated// query.NextPageTokenstring `json:"nextPageToken,omitempty"`// Services: Services available publicly or available to the// authenticated caller.Services []*PublishedService `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:"-"`}SearchServicesResponse: Response message for SearchServices method.
func (*SearchServicesResponse)MarshalJSON¶
func (s *SearchServicesResponse) MarshalJSON() ([]byte,error)
typeService¶
type Service 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`.ConfigVersionint64 `json:"configVersion,omitempty"`// Context: Context configuration.Context *Context `json:"context,omitempty"`// Control: Configuration for the service control plane.Control *Control `json:"control,omitempty"`// CustomError: Custom error configuration.CustomError *CustomError `json:"customError,omitempty"`// Documentation: Additional API documentation.Documentation *Documentation `json:"documentation,omitempty"`// Endpoints: Configuration for network endpoints. If this is empty,// then an endpoint// with the same name as the service is automatically generated to// service all// defined APIs.Endpoints []*Endpoint `json:"endpoints,omitempty"`// Enums: A list of all enum types included in this API service.// Enums// referenced directly or indirectly by the `apis` are// automatically// included. Enums which are not referenced but shall be// included// should be listed here by name. Example://// enums:// - name: google.someapi.v1.SomeEnumEnums []*Enum `json:"enums,omitempty"`// Experimental: Experimental configuration.Experimental *Experimental `json:"experimental,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.Idstring `json:"id,omitempty"`// Logging: Logging configuration.Logging *Logging `json:"logging,omitempty"`// Logs: Defines the logs used by this service.Logs []*LogDescriptor `json:"logs,omitempty"`// Metrics: Defines the metrics used by this service.Metrics []*MetricDescriptor `json:"metrics,omitempty"`// MonitoredResources: Defines the monitored resources used by this// service. This is required// by the Service.monitoring and Service.logging configurations.MonitoredResources []*MonitoredResourceDescriptor `json:"monitoredResources,omitempty"`// Monitoring: Monitoring configuration.Monitoring *Monitoring `json:"monitoring,omitempty"`// Name: The DNS address at which this service is available,// e.g. `calendar.googleapis.com`.Namestring `json:"name,omitempty"`// ProducerProjectId: The Google project that owns this service.ProducerProjectIdstring `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.Titlestring `json:"title,omitempty"`// Types: A list of all proto message types included in this API// service.// Types referenced directly or indirectly by the `apis`// are// automatically included. Messages which are not referenced but// shall be included, such as types used by the `google.protobuf.Any`// type,// should be listed here by name. Example://// types:// - name: google.protobuf.Int32Types []*Type `json:"types,omitempty"`// Usage: Configuration controlling usage of this service.Usage *Usage `json:"usage,omitempty"`// ForceSendFields is a list of field names (e.g. "Apis") to// unconditionally include in API requests. By default, fields with// empty 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:"-"`}Service: `Service` is the root object of Google service configurationschema. Itdescribes basic information about a service, such as the name andthetitle, and delegates other aspects to sub-sections. Each sub-sectioniseither a proto message or a repeated proto message that configuresaspecific aspect, such as auth. See each proto message definition fordetails.
Example:
type: google.api.Serviceconfig_version: 3name: calendar.googleapis.comtitle: Google Calendar APIapis:- name: google.calendar.v3.Calendarauthentication: 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 (*Service)MarshalJSON¶
typeServicesSearchCall¶
type ServicesSearchCall struct {// contains filtered or unexported fields}func (*ServicesSearchCall)Context¶
func (c *ServicesSearchCall) Context(ctxcontext.Context) *ServicesSearchCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*ServicesSearchCall)Do¶
func (c *ServicesSearchCall) Do(opts ...googleapi.CallOption) (*SearchServicesResponse,error)
Do executes the "serviceuser.services.search" call.Exactly one of *SearchServicesResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*SearchServicesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.
func (*ServicesSearchCall)Fields¶
func (c *ServicesSearchCall) Fields(s ...googleapi.Field) *ServicesSearchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*ServicesSearchCall)Header¶
func (c *ServicesSearchCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
func (*ServicesSearchCall)IfNoneMatch¶
func (c *ServicesSearchCall) IfNoneMatch(entityTagstring) *ServicesSearchCall
IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.
func (*ServicesSearchCall)PageSize¶
func (c *ServicesSearchCall) PageSize(pageSizeint64) *ServicesSearchCall
PageSize sets the optional parameter "pageSize": Requested size ofthe next page of data.
func (*ServicesSearchCall)PageToken¶
func (c *ServicesSearchCall) PageToken(pageTokenstring) *ServicesSearchCall
PageToken sets the optional parameter "pageToken": Token identifyingwhich result to start with; returned by a previous listcall.
func (*ServicesSearchCall)Pages¶
func (c *ServicesSearchCall) Pages(ctxcontext.Context, f func(*SearchServicesResponse)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.
typeServicesService¶
type ServicesService struct {// contains filtered or unexported fields}funcNewServicesService¶
func NewServicesService(s *APIService) *ServicesService
func (*ServicesService)Search¶
func (r *ServicesService) Search() *ServicesSearchCall
Search: Search available services.
When no filter is specified, returns all accessible services.Forauthenticated users, also returns all services the calling userhas"servicemanagement.services.bind" permission for.
typeSourceContext¶
type SourceContext struct {// FileName: The path-qualified name of the .proto file that contained// the associated// protobuf element. For example:// "google/protobuf/source_context.proto".FileNamestring `json:"fileName,omitempty"`// ForceSendFields is a list of field names (e.g. "FileName") to// unconditionally include in API requests. By default, fields with// empty 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 thesource of aprotobuf element, like the file in which it is defined.
func (*SourceContext)MarshalJSON¶
func (s *SourceContext) MarshalJSON() ([]byte,error)
typeSourceInfo¶
type SourceInfo struct {// SourceFiles: All files used during config generation.SourceFiles []googleapi.RawMessage `json:"sourceFiles,omitempty"`// ForceSendFields is a list of field names (e.g. "SourceFiles") to// unconditionally include in API requests. By default, fields with// empty 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¶
func (s *SourceInfo) MarshalJSON() ([]byte,error)
typeStatus¶
type Status struct {// Code: The status code, which should be an enum value of// google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a// common set of// message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in// English. Any// user-facing error message should be localized and sent in// the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to// unconditionally include in API requests. By default, fields with// empty 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 issuitable for differentprogramming environments, including REST APIs and RPC APIs. It isused by[gRPC](https://github.com/grpc). The error model is designed tobe:
- Simple to use and understand for most users- Flexible enough to meet unexpected needs
Overview¶
The `Status` message contains three pieces of data: error code, errormessage,and error details. The error code should be an enum valueofgoogle.rpc.Code, but it may accept additional error codes if needed.Theerror message should be a developer-facing English message thathelpsdevelopers *understand* and *resolve* the error. If a localizeduser-facingerror message is needed, put the localized message in the errordetails orlocalize it in the client. The optional error details may containarbitraryinformation about the error. There is a predefined set of errordetail typesin the package `google.rpc` that can be used for common errorconditions.
Language mapping¶
The `Status` message is the logical representation of the errormodel, but itis not necessarily the actual wire format. When the `Status` messageisexposed in different client libraries and different wire protocols,it can bemapped differently. For example, it will likely be mapped to someexceptionsin Java, but more likely mapped to some error codes in C.
Other uses¶
The error model and the `Status` message can be used in a varietyofenvironments, either with or without APIs, to provide aconsistent developer experience across differentenvironments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to theclient,
it may embed the `Status` in the normal response to indicate the
partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each stepmay
have a `Status` message for error reporting.
- Batch operations. If a client uses batch request and batchresponse, the
`Status` message should be used directly inside batch response,
one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronousoperation
results in its response, the status of those operations should
be
represented directly using the `Status` message.
- Logging. If some API errors are stored in logs, the message`Status` could
be used directly after any stripping needed for security/privacy
reasons.
func (*Status)MarshalJSON¶
typeStep¶
type Step struct {// Description: The short description of the step.Descriptionstring `json:"description,omitempty"`// Status: The status code.//// Possible values:// "STATUS_UNSPECIFIED" - Unspecifed code.// "DONE" - The operation or step has completed without errors.// "NOT_STARTED" - The operation or step has not started yet.// "IN_PROGRESS" - The operation or step is in progress.// "FAILED" - The operation or step has completed with errors. If the// operation is// rollbackable, the rollback completed with errors too.// "CANCELLED" - The operation or step has completed with// cancellation.Statusstring `json:"status,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:"-"`}Step: Represents the status of one operation step.
func (*Step)MarshalJSON¶
typeSystemParameter¶
type SystemParameter struct {// HttpHeader: Define the HTTP header name to use for the parameter. It// is case// insensitive.HttpHeaderstring `json:"httpHeader,omitempty"`// Name: Define the name of the parameter, such as "api_key" . It is// case sensitive.Namestring `json:"name,omitempty"`// UrlQueryParameter: Define the URL query parameter name to use for the// parameter. It is case// sensitive.UrlQueryParameterstring `json:"urlQueryParameter,omitempty"`// ForceSendFields is a list of field names (e.g. "HttpHeader") to// unconditionally include in API requests. By default, fields with// empty 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. Theparameter may be passed as eitheran HTTP header or a URL query parameter, and if both are passed thebehavioris implementation-dependent.
func (*SystemParameter)MarshalJSON¶
func (s *SystemParameter) MarshalJSON() ([]byte,error)
typeSystemParameterRule¶
type SystemParameterRule struct {// Parameters: Define parameters. Multiple names may be defined for a// parameter.// For a given method call, only one of them should be used. If// multiple// names are used the behavior is implementation-dependent.// If none of the specified names are present the behavior// is// parameter-dependent.Parameters []*SystemParameter `json:"parameters,omitempty"`// Selector: Selects the methods to which this rule applies. Use '*' to// indicate all// methods in all APIs.//// Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// ForceSendFields is a list of field names (e.g. "Parameters") to// unconditionally include in API requests. By default, fields with// empty 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 systemparameter definitions tomethods.
func (*SystemParameterRule)MarshalJSON¶
func (s *SystemParameterRule) MarshalJSON() ([]byte,error)
typeSystemParameters¶
type SystemParameters struct {// Rules: Define system parameters.//// The parameters defined here will override the default// parameters// implemented by the system. If this field is missing from the// service// config, default system parameters will be used. Default system// parameters// and names is implementation-dependent.//// Example: define api key for all methods//// system_parameters// rules:// - selector: "*"// parameters:// - name: api_key// url_query_parameter: api_key////// Example: define 2 api key names for a specific method.//// system_parameters// rules:// - selector: "/ListShelves"// parameters:// - name: api_key// http_header: Api-Key1// - name: api_key// http_header: Api-Key2//// **NOTE:** All service configuration rules follow "last one wins"// order.Rules []*SystemParameterRule `json:"rules,omitempty"`// ForceSendFields is a list of field names (e.g. "Rules") to// unconditionally include in API requests. By default, fields with// empty 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 theAPIsystem, not by an individual API. It is typically mapped to an HTTPheaderand/or a URL query parameter. This configuration specifies whichmethodschange the names of the system parameters.
func (*SystemParameters)MarshalJSON¶
func (s *SystemParameters) MarshalJSON() ([]byte,error)
typeType¶
type Type struct {// Fields: The list of fields.Fields []*Field `json:"fields,omitempty"`// Name: The fully qualified message name.Namestring `json:"name,omitempty"`// Oneofs: The list of types appearing in `oneof` definitions in this// type.Oneofs []string `json:"oneofs,omitempty"`// Options: The protocol buffer options.Options []*Option `json:"options,omitempty"`// SourceContext: The source context.SourceContext *SourceContext `json:"sourceContext,omitempty"`// Syntax: The source syntax.//// Possible values:// "SYNTAX_PROTO2" - Syntax `proto2`.// "SYNTAX_PROTO3" - Syntax `proto3`.Syntaxstring `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¶
typeUsage¶
type Usage struct {// ProducerNotificationChannel: The full resource name of a channel used// for sending notifications to the// service producer.//// Google Service Management currently only supports// [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a// notification// channel. To use Google Cloud Pub/Sub as the channel, this must be the// name// of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name// format// documented inhttps://cloud.google.com/pubsub/docs/overview.ProducerNotificationChannelstring `json:"producerNotificationChannel,omitempty"`// Requirements: Requirements that must be satisfied before a consumer// project can use the// service. Each requirement is of the form// <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¶
typeUsageRule¶
type UsageRule struct {// AllowUnregisteredCalls: If true, the selected method allows// unregistered calls, e.g. calls// that don't identify any user or application.AllowUnregisteredCallsbool `json:"allowUnregisteredCalls,omitempty"`// Selector: Selects the methods to which this rule applies. Use '*' to// indicate all// methods in all APIs.//// Refer to selector for syntax details.Selectorstring `json:"selector,omitempty"`// SkipServiceControl: If true, the selected method should skip service// control and the control// plane features, such as quota and billing, will not be// available.// This flag is used by Google Cloud Endpoints to bypass checks for// internal// methods, such as service health check methods.SkipServiceControlbool `json:"skipServiceControl,omitempty"`// ForceSendFields is a list of field names (e.g.// "AllowUnregisteredCalls") to unconditionally include in API requests.// By default, fields with empty 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.Unregisteredcalls are calls that do not contain consumer projectidentity.(Example: calls that do not contain an API key).By default, API methods do not allow unregistered calls, and eachmethod callmust be identified by a consumer project identity. Use this ruletoallow/disallow unregistered calls.
Example of an API that wants to allow unregistered calls for entireservice.
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