Documentation ¶
Overview ¶
Package servicemanagement provides access to the Google Service Management API.
See https://cloud.google.com/service-management/
Usage example:
import "google.golang.org/api/servicemanagement/v1" ... servicemanagementService, err := servicemanagement.New(oauthHttpClient)
Index ¶
- Constants
- type APIService
- type Advice
- type Analytics
- type AnalyticsDestination
- type Api
- type AuditConfig
- type AuthProvider
- type AuthRequirement
- type Authentication
- type AuthenticationRule
- type Backend
- type BackendRule
- type Binding
- type ChangeReport
- type CloudAuditOptions
- type Condition
- type ConfigChange
- type ConfigFile
- type ConfigRef
- type ConfigSource
- type Context
- type ContextRule
- type Control
- type CounterOptions
- type CustomError
- type CustomErrorRule
- type CustomHttpPattern
- type DataAccessOptions
- type DeleteServiceStrategy
- type Diagnostic
- type DisableServiceRequest
- type Documentation
- type DocumentationRule
- type EnableServiceRequest
- type Endpoint
- type Enum
- type EnumValue
- type Field
- type GenerateConfigReportRequest
- type GenerateConfigReportRequestNewConfig
- type GenerateConfigReportRequestOldConfig
- type GenerateConfigReportResponse
- type GetIamPolicyRequest
- type Http
- type HttpRule
- type LabelDescriptor
- type ListServiceConfigsResponse
- type ListServiceRolloutsResponse
- type ListServicesResponse
- type LogConfig
- type LogDescriptor
- type Logging
- type LoggingDestination
- type ManagedService
- type MediaDownload
- type MediaUpload
- type Method
- type MetricDescriptor
- type Mixin
- type MonitoredResourceDescriptor
- type Monitoring
- type MonitoringDestination
- type OAuthRequirements
- type Operation
- type OperationMetadata
- type OperationMetadata1
- type OperationResponse
- type OperationsGetCall
- func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
- func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
- func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
- type OperationsService
- type Option
- type OptionValue
- type Page
- type Policy
- type Rollout
- type Rule
- type Service
- type ServicesConfigsCreateCall
- type ServicesConfigsGetCall
- func (c *ServicesConfigsGetCall) Context(ctx context.Context) *ServicesConfigsGetCall
- func (c *ServicesConfigsGetCall) Do(opts ...googleapi.CallOption) (*Service, error)
- func (c *ServicesConfigsGetCall) Fields(s ...googleapi.Field) *ServicesConfigsGetCall
- func (c *ServicesConfigsGetCall) IfNoneMatch(entityTag string) *ServicesConfigsGetCall
- type ServicesConfigsListCall
- func (c *ServicesConfigsListCall) Context(ctx context.Context) *ServicesConfigsListCall
- func (c *ServicesConfigsListCall) Do(opts ...googleapi.CallOption) (*ListServiceConfigsResponse, error)
- func (c *ServicesConfigsListCall) Fields(s ...googleapi.Field) *ServicesConfigsListCall
- func (c *ServicesConfigsListCall) IfNoneMatch(entityTag string) *ServicesConfigsListCall
- func (c *ServicesConfigsListCall) PageSize(pageSize int64) *ServicesConfigsListCall
- func (c *ServicesConfigsListCall) PageToken(pageToken string) *ServicesConfigsListCall
- func (c *ServicesConfigsListCall) Pages(ctx context.Context, f func(*ListServiceConfigsResponse) error) error
- type ServicesConfigsService
- func (r *ServicesConfigsService) Create(serviceName string, service *Service) *ServicesConfigsCreateCall
- func (r *ServicesConfigsService) Get(serviceName string, configId string) *ServicesConfigsGetCall
- func (r *ServicesConfigsService) List(serviceName string) *ServicesConfigsListCall
- func (r *ServicesConfigsService) Submit(serviceName string, submitconfigsourcerequest *SubmitConfigSourceRequest) *ServicesConfigsSubmitCall
- type ServicesConfigsSubmitCall
- type ServicesCreateCall
- type ServicesDeleteCall
- type ServicesDisableCall
- type ServicesEnableCall
- type ServicesGenerateConfigReportCall
- func (c *ServicesGenerateConfigReportCall) Context(ctx context.Context) *ServicesGenerateConfigReportCall
- func (c *ServicesGenerateConfigReportCall) Do(opts ...googleapi.CallOption) (*GenerateConfigReportResponse, error)
- func (c *ServicesGenerateConfigReportCall) Fields(s ...googleapi.Field) *ServicesGenerateConfigReportCall
- type ServicesGetCall
- func (c *ServicesGetCall) Context(ctx context.Context) *ServicesGetCall
- func (c *ServicesGetCall) Do(opts ...googleapi.CallOption) (*ManagedService, error)
- func (c *ServicesGetCall) Fields(s ...googleapi.Field) *ServicesGetCall
- func (c *ServicesGetCall) IfNoneMatch(entityTag string) *ServicesGetCall
- type ServicesGetConfigCall
- func (c *ServicesGetConfigCall) ConfigId(configId string) *ServicesGetConfigCall
- func (c *ServicesGetConfigCall) Context(ctx context.Context) *ServicesGetConfigCall
- func (c *ServicesGetConfigCall) Do(opts ...googleapi.CallOption) (*Service, error)
- func (c *ServicesGetConfigCall) Fields(s ...googleapi.Field) *ServicesGetConfigCall
- func (c *ServicesGetConfigCall) IfNoneMatch(entityTag string) *ServicesGetConfigCall
- type ServicesGetIamPolicyCall
- type ServicesListCall
- func (c *ServicesListCall) Context(ctx context.Context) *ServicesListCall
- func (c *ServicesListCall) Do(opts ...googleapi.CallOption) (*ListServicesResponse, error)
- func (c *ServicesListCall) Fields(s ...googleapi.Field) *ServicesListCall
- func (c *ServicesListCall) IfNoneMatch(entityTag string) *ServicesListCall
- func (c *ServicesListCall) PageSize(pageSize int64) *ServicesListCall
- func (c *ServicesListCall) PageToken(pageToken string) *ServicesListCall
- func (c *ServicesListCall) Pages(ctx context.Context, f func(*ListServicesResponse) error) error
- func (c *ServicesListCall) ProducerProjectId(producerProjectId string) *ServicesListCall
- type ServicesRolloutsCreateCall
- type ServicesRolloutsGetCall
- func (c *ServicesRolloutsGetCall) Context(ctx context.Context) *ServicesRolloutsGetCall
- func (c *ServicesRolloutsGetCall) Do(opts ...googleapi.CallOption) (*Rollout, error)
- func (c *ServicesRolloutsGetCall) Fields(s ...googleapi.Field) *ServicesRolloutsGetCall
- func (c *ServicesRolloutsGetCall) IfNoneMatch(entityTag string) *ServicesRolloutsGetCall
- type ServicesRolloutsListCall
- func (c *ServicesRolloutsListCall) Context(ctx context.Context) *ServicesRolloutsListCall
- func (c *ServicesRolloutsListCall) Do(opts ...googleapi.CallOption) (*ListServiceRolloutsResponse, error)
- func (c *ServicesRolloutsListCall) Fields(s ...googleapi.Field) *ServicesRolloutsListCall
- func (c *ServicesRolloutsListCall) IfNoneMatch(entityTag string) *ServicesRolloutsListCall
- func (c *ServicesRolloutsListCall) PageSize(pageSize int64) *ServicesRolloutsListCall
- func (c *ServicesRolloutsListCall) PageToken(pageToken string) *ServicesRolloutsListCall
- func (c *ServicesRolloutsListCall) Pages(ctx context.Context, f func(*ListServiceRolloutsResponse) error) error
- type ServicesRolloutsService
- type ServicesService
- func (r *ServicesService) Create(managedservice *ManagedService) *ServicesCreateCall
- func (r *ServicesService) Delete(serviceName string) *ServicesDeleteCall
- func (r *ServicesService) Disable(serviceName string, disableservicerequest *DisableServiceRequest) *ServicesDisableCall
- func (r *ServicesService) Enable(serviceName string, enableservicerequest *EnableServiceRequest) *ServicesEnableCall
- func (r *ServicesService) GenerateConfigReport(generateconfigreportrequest *GenerateConfigReportRequest) *ServicesGenerateConfigReportCall
- func (r *ServicesService) Get(serviceName string) *ServicesGetCall
- func (r *ServicesService) GetConfig(serviceName string) *ServicesGetConfigCall
- func (r *ServicesService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ServicesGetIamPolicyCall
- func (r *ServicesService) List() *ServicesListCall
- func (r *ServicesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ServicesSetIamPolicyCall
- func (r *ServicesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ServicesTestIamPermissionsCall
- func (r *ServicesService) Undelete(serviceName string) *ServicesUndeleteCall
- type ServicesSetIamPolicyCall
- type ServicesTestIamPermissionsCall
- func (c *ServicesTestIamPermissionsCall) Context(ctx context.Context) *ServicesTestIamPermissionsCall
- func (c *ServicesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *ServicesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ServicesTestIamPermissionsCall
- type ServicesUndeleteCall
- type SetIamPolicyRequest
- type SourceContext
- type Status
- type StatusDetails
- type Step
- type SubmitConfigSourceRequest
- type SubmitConfigSourceResponse
- type SystemParameter
- type SystemParameterRule
- type SystemParameters
- type TestIamPermissionsRequest
- type TestIamPermissionsResponse
- type TrafficPercentStrategy
- type Type
- type UndeleteServiceResponse
- type Usage
- type UsageRule
- type Visibility
- type VisibilityRule
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // View your data across Google Cloud Platform services CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only" // Manage your Google API service configuration ServiceManagementScope = "https://www.googleapis.com/auth/service.management" // View your Google API service configuration ServiceManagementReadonlyScope = "https://www.googleapis.com/auth/service.management.readonly" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIService ¶
type APIService struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Operations *OperationsService Services *ServicesService // contains filtered or unexported fields }
type Advice ¶
type Advice struct { // Description: Useful description for why this advice was applied and // what actions should // be taken to mitigate any implied risks. Description string `json:"description,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:"-"` }
Advice: Generated advice about this change, used for providing more information about how a change will affect the existing service.
func (*Advice) MarshalJSON ¶
type Analytics ¶
type Analytics struct { // ProducerDestinations: Analytics configurations for sending metrics to // the analytics backend. // 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 []*AnalyticsDestination `json:"producerDestinations,omitempty"` // ForceSendFields is a list of field names (e.g. // "ProducerDestinations") 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. "ProducerDestinations") 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:"-"` }
Analytics: Analytics configuration of the service.
The example below shows how to configure monitored resources and metrics for analytics. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` and `library.googleapis.com/book/overdue_count` metric are sent to the analytics.
monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located
in.
- key: /name description: The name of the branch. metrics:
- name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels:
- key: /customer_id
- name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels:
- key: /customer_id analytics: producer_destinations:
- monitored_resource: library.googleapis.com/branch metrics:
- library.googleapis.com/book/returned_count
- library.googleapis.com/book/overdue_count
func (*Analytics) MarshalJSON ¶
type AnalyticsDestination ¶
type AnalyticsDestination struct { // Metrics: Names of the metrics to report to this analytics // destination. // Each name must be defined in Service.metrics section. Metrics // with value type BOOL and STRING must be of GUAGE kind, metrics // with // value type INT64, DOUBLE and MONEY must be of DELTA kind. Metrics []string `json:"metrics,omitempty"` // MonitoredResource: The monitored resource type. The type must be // defined in // Service.monitored_resources section. MonitoredResource string `json:"monitoredResource,omitempty"` // ForceSendFields is a list of field names (e.g. "Metrics") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metrics") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnalyticsDestination: Configuration of a specific analytics destination.
func (*AnalyticsDestination) MarshalJSON ¶
func (s *AnalyticsDestination) MarshalJSON() ([]byte, error)
type Api ¶
type Api struct { // Methods: The methods of this api, in unspecified order. Methods []*Method `json:"methods,omitempty"` // Mixins: Included APIs. See Mixin. Mixins []*Mixin `json:"mixins,omitempty"` // Name: The fully qualified name of this api, including package // name // followed by the api's simple name. Name string `json:"name,omitempty"` // Options: Any metadata attached to the API. Options []*Option `json:"options,omitempty"` // SourceContext: Source context for the protocol buffer service // represented by this // message. SourceContext *SourceContext `json:"sourceContext,omitempty"` // Syntax: The source syntax of the service. // // Possible values: // "SYNTAX_PROTO2" - Syntax `proto2`. // "SYNTAX_PROTO3" - Syntax `proto3`. Syntax string `json:"syntax,omitempty"` // Version: A version string for this api. 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 // API, 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, none-GA apis. // Version string `json:"version,omitempty"` // ForceSendFields is a list of field names (e.g. "Methods") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Methods") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Api: Api is a light-weight descriptor for a protocol buffer service.
func (*Api) MarshalJSON ¶
type AuditConfig ¶
type AuditConfig struct { // ExemptedMembers: Specifies the identities that are exempted from // "data access" audit // logging for the `service` specified above. // Follows the same format of Binding.members. ExemptedMembers []string `json:"exemptedMembers,omitempty"` // Service: Specifies a service that will be enabled for "data access" // audit // logging. // For example, `resourcemanager`, `storage`, `compute`. // `allServices` is a special value that covers all services. Service string `json:"service,omitempty"` // ForceSendFields is a list of field names (e.g. "ExemptedMembers") 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. "ExemptedMembers") 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:"-"` }
AuditConfig: Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
func (*AuditConfig) MarshalJSON ¶
func (s *AuditConfig) MarshalJSON() ([]byte, error)
type AuthProvider ¶
type AuthProvider struct { // Id: The unique identifier of the auth provider. It will be referred // to by // `AuthRequirement.provider_id`. // // Example: "bookstore_auth". Id string `json:"id,omitempty"` // Issuer: Identifies the principal that issued the JWT. // See // https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#sec // tion-4.1.1 // Usually a URL or an email address. // // Example: https://securetoken.google.com // Example: 1234567-compute@developer.gserviceaccount.com Issuer string `json:"issuer,omitempty"` // JwksUri: URL of the provider's public key set to validate signature // of the JWT. See // [OpenID // Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# // ProviderMetadata). // Optional if the key set document: // - can be retrieved from // [OpenID // Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html // // of the issuer. // - can be inferred from the email domain of the issuer (e.g. a Google // service account). // // Example: https://www.googleapis.com/oauth2/v1/certs JwksUri string `json:"jwksUri,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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, including support 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)
type AuthRequirement ¶
type AuthRequirement struct { // Audiences: The list of // JWT // [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web- // token-32#section-4.1.3). // that are allowed to access. A JWT containing any of these audiences // will // be accepted. When this setting is absent, only JWTs with // audience // "https://Service_name/API_name" // will be accepted. For example, if no audiences are in the // setting, // LibraryService API will only accept JWTs with the following // audience // "https://library-example.googleapis.com/google.example.librar // y.v1.LibraryService". // // Example: // // audiences: bookstore_android.apps.googleusercontent.com, // bookstore_web.apps.googleusercontent.com Audiences string `json:"audiences,omitempty"` // ProviderId: id from authentication provider. // // Example: // // provider_id: bookstore_auth ProviderId string `json:"providerId,omitempty"` // ForceSendFields is a list of field names (e.g. "Audiences") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Audiences") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AuthRequirement: User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32) .
func (*AuthRequirement) MarshalJSON ¶
func (s *AuthRequirement) MarshalJSON() ([]byte, error)
type Authentication ¶
type Authentication struct { // Providers: Defines a set of authentication providers that a service // supports. Providers []*AuthProvider `json:"providers,omitempty"` // Rules: A list of authentication rules that apply to individual API // methods. // // **NOTE:** All service configuration rules follow "last one wins" // order. Rules []*AuthenticationRule `json:"rules,omitempty"` // ForceSendFields is a list of field names (e.g. "Providers") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Providers") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Authentication: `Authentication` defines the authentication configuration for an API.
Example for an API targeted for external use:
name: calendar.googleapis.com authentication: rules: - selector: "*" oauth: canonical_scopes:
https://www.googleapis.com/auth/calendar
- selector: google.calendar.Delegate oauth: canonical_scopes:
https://www.googleapis.com/auth/calendar.read
func (*Authentication) MarshalJSON ¶
func (s *Authentication) MarshalJSON() ([]byte, error)
type AuthenticationRule ¶
type AuthenticationRule struct { // AllowWithoutCredential: Whether to allow requests without a // credential. The credential can be // an OAuth token, Google cookies (first-party auth) or // EndUserCreds. // // For requests without credentials, if the service control environment // is // specified, each incoming request **must** be associated with a // service // consumer. This can be done by passing an API key that belongs to a // consumer // project. AllowWithoutCredential bool `json:"allowWithoutCredential,omitempty"` // Oauth: The requirements for OAuth credentials. Oauth *OAuthRequirements `json:"oauth,omitempty"` // Requirements: Requirements for additional authentication providers. Requirements []*AuthRequirement `json:"requirements,omitempty"` // Selector: Selects the methods to which this rule applies. // // Refer to selector for syntax details. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. // "AllowWithoutCredential") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AllowWithoutCredential") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AuthenticationRule: Authentication rules for the service.
By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request.
If a method doesn't have any auth requirements, request credentials will be ignored.
func (*AuthenticationRule) MarshalJSON ¶
func (s *AuthenticationRule) MarshalJSON() ([]byte, error)
type Backend ¶
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 ¶
type BackendRule ¶
type BackendRule struct { // Address: The address of the API backend. Address string `json:"address,omitempty"` // Deadline: The number of seconds to wait for a response from a // request. The // default depends on the deployment context. Deadline float64 `json:"deadline,omitempty"` // Selector: Selects the methods to which this rule applies. // // Refer to selector for syntax details. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. "Address") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Address") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BackendRule: A backend rule provides configuration for an individual API element.
func (*BackendRule) MarshalJSON ¶
func (s *BackendRule) MarshalJSON() ([]byte, error)
type Binding ¶
type Binding struct { // Members: Specifies the identities requesting access for a Cloud // Platform resource. // `members` can have the following values: // // * `allUsers`: A special identifier that represents anyone who is // on the internet; with or without a Google account. // // * `allAuthenticatedUsers`: A special identifier that represents // anyone // who is authenticated with a Google account or a service // account. // // * `user:{emailid}`: An email address that represents a specific // Google // account. For example, `alice@gmail.com` or `joe@example.com`. // // // * `serviceAccount:{emailid}`: An email address that represents a // service // account. For example, // `my-other-app@appspot.gserviceaccount.com`. // // * `group:{emailid}`: An email address that represents a Google // group. // For example, `admins@example.com`. // // * `domain:{domain}`: A Google Apps domain name that represents all // the // users of that domain. For example, `google.com` or // `example.com`. // // Members []string `json:"members,omitempty"` // Role: Role that is assigned to `members`. // For example, `roles/viewer`, `roles/editor`, or // `roles/owner`. // Required Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Members") 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. "Members") 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:"-"` }
Binding: Associates `members` with a `role`.
func (*Binding) MarshalJSON ¶
type ChangeReport ¶
type ChangeReport struct { // ConfigChanges: List of changes between two service // configurations. // The changes will be alphabetically sorted based on the identifier // of each change. // A ConfigChange identifier is a dot separated path to the // configuration. // Example: // visibility.rules[selector='LibraryService.CreateBook'].restriction ConfigChanges []*ConfigChange `json:"configChanges,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfigChanges") 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. "ConfigChanges") 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:"-"` }
ChangeReport: Change report associated with a particular service configuration.
It contains a list of ConfigChanges based on the comparison between two service configurations.
func (*ChangeReport) MarshalJSON ¶
func (s *ChangeReport) MarshalJSON() ([]byte, error)
type CloudAuditOptions ¶
type CloudAuditOptions struct { }
CloudAuditOptions: Write a Cloud Audit log
type Condition ¶
type Condition struct { // Iam: Trusted attributes supplied by the IAM system. // // Possible values: // "NO_ATTR" - Default non-attribute. // "AUTHORITY" - Either principal or (if present) authority selector. // "ATTRIBUTION" - The principal (even if an authority selector is // present), which // must only be used for attribution, not authorization. Iam string `json:"iam,omitempty"` // Op: An operator to apply the subject with. // // Possible values: // "NO_OP" - Default no-op. // "EQUALS" - DEPRECATED. Use IN instead. // "NOT_EQUALS" - DEPRECATED. Use NOT_IN instead. // "IN" - Set-inclusion check. // "NOT_IN" - Set-exclusion check. // "DISCHARGED" - Subject is discharged Op string `json:"op,omitempty"` // Svc: Trusted attributes discharged by the service. Svc string `json:"svc,omitempty"` // Sys: Trusted attributes supplied by any service that owns resources // and uses // the IAM system for access control. // // Possible values: // "NO_ATTR" - Default non-attribute type // "REGION" - Region of the resource // "SERVICE" - Service name // "NAME" - Resource name // "IP" - IP address of the caller Sys string `json:"sys,omitempty"` // Value: DEPRECATED. Use 'values' instead. Value string `json:"value,omitempty"` // Values: The objects of the condition. This is mutually exclusive with // 'value'. Values []string `json:"values,omitempty"` // ForceSendFields is a list of field names (e.g. "Iam") 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. "Iam") 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:"-"` }
Condition: A condition to be met.
func (*Condition) MarshalJSON ¶
type ConfigChange ¶
type ConfigChange struct { // Advices: Collection of advice provided for this change, useful for // determining the // possible impact of this change. Advices []*Advice `json:"advices,omitempty"` // ChangeType: The type for this change, either ADDED, REMOVED, or // MODIFIED. // // Possible values: // "CHANGE_TYPE_UNSPECIFIED" - No value was provided. // "ADDED" - The changed object exists in the 'new' service // configuration, but not // in the 'old' service configuration. // "REMOVED" - The changed object exists in the 'old' service // configuration, but not // in the 'new' service configuration. // "MODIFIED" - The changed object exists in both service // configurations, but its value // is different. ChangeType string `json:"changeType,omitempty"` // Element: Object hierarchy path to the change, with levels separated // by a '.' // character. For repeated fields, an applicable unique identifier field // is // used for the index (usually selector, name, or id). For maps, the // term // 'key' is used. If the field has no unique identifier, the numeric // index // is used. // Examples: // - // visibility.rules[selector=="google.LibraryService.CreateBook"].restric // tion // - // quota.metric_rules[selector=="google"].metric_costs[key=="reads"].valu // e // - logging.producer_destinations[0] Element string `json:"element,omitempty"` // NewValue: Value of the changed object in the new Service // configuration, // in JSON format. This field will not be populated if ChangeType == // REMOVED. NewValue string `json:"newValue,omitempty"` // OldValue: Value of the changed object in the old Service // configuration, // in JSON format. This field will not be populated if ChangeType == // ADDED. OldValue string `json:"oldValue,omitempty"` // ForceSendFields is a list of field names (e.g. "Advices") 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. "Advices") 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:"-"` }
ConfigChange: Output generated from semantically comparing two versions of a service configuration.
Includes detailed information about a field that have changed with applicable advice about potential consequences for the change, such as backwards-incompatibility.
func (*ConfigChange) MarshalJSON ¶
func (s *ConfigChange) MarshalJSON() ([]byte, error)
type ConfigFile ¶
type ConfigFile struct { // FileContents: The bytes that constitute the file. FileContents string `json:"fileContents,omitempty"` // FilePath: The file name of the configuration file (full or relative // path). FilePath string `json:"filePath,omitempty"` // FileType: The type of configuration file this represents. // // Possible values: // "FILE_TYPE_UNSPECIFIED" - Unknown file type. // "SERVICE_CONFIG_YAML" - YAML-specification of service. // "OPEN_API_JSON" - OpenAPI specification, serialized in JSON. // "OPEN_API_YAML" - OpenAPI specification, serialized in YAML. // "FILE_DESCRIPTOR_SET_PROTO" - FileDescriptorSet, generated by // protoc. // // To generate, use protoc with imports and source info included. // For an example test.proto file, the following command would put the // value // in a new file named out.pb. // // $protoc --include_imports --include_source_info test.proto -o out.pb FileType string `json:"fileType,omitempty"` // ForceSendFields is a list of field names (e.g. "FileContents") 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. "FileContents") 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:"-"` }
ConfigFile: Generic specification of a source configuration file
func (*ConfigFile) MarshalJSON ¶
func (s *ConfigFile) MarshalJSON() ([]byte, error)
type ConfigRef ¶
type ConfigRef struct { // Name: Resource name of a service config. It must have the // following // format: "services/{service name}/configs/{config id}". Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty 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:"-"` }
ConfigRef: Represents a service configuration with its name and id.
func (*ConfigRef) MarshalJSON ¶
type ConfigSource ¶
type ConfigSource struct { // Files: Set of source configuration files that are used to generate a // service // configuration (`google.api.Service`). Files []*ConfigFile `json:"files,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. Id string `json:"id,omitempty"` // ForceSendFields is a list of field names (e.g. "Files") 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. "Files") 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:"-"` }
ConfigSource: Represents a source file which is used to generate the service configuration defined by `google.api.Service`.
func (*ConfigSource) MarshalJSON ¶
func (s *ConfigSource) MarshalJSON() ([]byte, error)
type Context ¶
type Context struct { // Rules: A list of RPC context rules that apply to individual API // methods. // // **NOTE:** All service configuration rules follow "last one wins" // order. Rules []*ContextRule `json:"rules,omitempty"` // ForceSendFields is a list of field names (e.g. "Rules") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Rules") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Context: `Context` defines which contexts an API requests.
Example:
context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext
The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
Available context types are defined in package `google.rpc.context`.
func (*Context) MarshalJSON ¶
type ContextRule ¶
type ContextRule struct { // Provided: A list of full type names of provided contexts. Provided []string `json:"provided,omitempty"` // Requested: A list of full type names of requested contexts. Requested []string `json:"requested,omitempty"` // Selector: Selects the methods to which this rule applies. // // Refer to selector for syntax details. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. "Provided") 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. "Provided") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ContextRule: A context rule provides information about the context for an individual API element.
func (*ContextRule) MarshalJSON ¶
func (s *ContextRule) MarshalJSON() ([]byte, error)
type Control ¶
type Control struct { // Environment: The service control environment to use. If empty, no // control plane // feature (like quota and billing) will be enabled. Environment string `json:"environment,omitempty"` // ForceSendFields is a list of field names (e.g. "Environment") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Environment") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Control: Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.
func (*Control) MarshalJSON ¶
type CounterOptions ¶
type CounterOptions struct { // Field: The field value to attribute. Field string `json:"field,omitempty"` // Metric: The metric to update. Metric string `json:"metric,omitempty"` // ForceSendFields is a list of field names (e.g. "Field") 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. "Field") 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:"-"` }
CounterOptions: Options for counters
func (*CounterOptions) MarshalJSON ¶
func (s *CounterOptions) MarshalJSON() ([]byte, error)
type CustomError ¶
type CustomError struct { // Rules: The list of custom error rules that apply to individual API // messages. // // **NOTE:** All service configuration rules follow "last one wins" // order. Rules []*CustomErrorRule `json:"rules,omitempty"` // Types: The list of custom error detail types, e.g. // 'google.foo.v1.CustomError'. Types []string `json:"types,omitempty"` // ForceSendFields is a list of field names (e.g. "Rules") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Rules") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CustomError: Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses.
Example:
custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError
func (*CustomError) MarshalJSON ¶
func (s *CustomError) MarshalJSON() ([]byte, error)
type CustomErrorRule ¶
type CustomErrorRule struct { // IsErrorType: Mark this message as possible payload in error response. // Otherwise, // objects of this type will be filtered when they appear in error // payload. IsErrorType bool `json:"isErrorType,omitempty"` // Selector: Selects messages to which this rule applies. // // Refer to selector for syntax details. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. "IsErrorType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IsErrorType") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CustomErrorRule: A custom error rule.
func (*CustomErrorRule) MarshalJSON ¶
func (s *CustomErrorRule) MarshalJSON() ([]byte, error)
type CustomHttpPattern ¶
type CustomHttpPattern struct { // Kind: The name of this custom HTTP verb. Kind string `json:"kind,omitempty"` // Path: The path matched by this custom verb. Path string `json:"path,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CustomHttpPattern: A custom pattern is used for defining custom HTTP verb.
func (*CustomHttpPattern) MarshalJSON ¶
func (s *CustomHttpPattern) MarshalJSON() ([]byte, error)
type DataAccessOptions ¶
type DataAccessOptions struct { }
DataAccessOptions: Write a Data Access (Gin) log
type DeleteServiceStrategy ¶
type DeleteServiceStrategy struct { }
DeleteServiceStrategy: Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.
type Diagnostic ¶
type Diagnostic struct { // Kind: The kind of diagnostic information provided. // // Possible values: // "WARNING" - Warnings and errors // "ERROR" - Only errors Kind string `json:"kind,omitempty"` // Location: File name and line number of the error or warning. Location string `json:"location,omitempty"` // Message: Message describing the error or warning. Message string `json:"message,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:"-"` }
Diagnostic: Represents a diagnostic message (error or warning)
func (*Diagnostic) MarshalJSON ¶
func (s *Diagnostic) MarshalJSON() ([]byte, error)
type DisableServiceRequest ¶
type DisableServiceRequest struct { // ConsumerId: The identity of consumer resource which service // disablement will be // applied to. // // The Google Service Management implementation accepts the // following // forms: "project:<project_id>", // "project_number:<project_number>". // // Note: this is made compatible // with // google.api.servicecontrol.v1.Operation.consumer_id. ConsumerId string `json:"consumerId,omitempty"` // ForceSendFields is a list of field names (e.g. "ConsumerId") 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. "ConsumerId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
DisableServiceRequest: Request message for DisableService method.
func (*DisableServiceRequest) MarshalJSON ¶
func (s *DisableServiceRequest) MarshalJSON() ([]byte, error)
type Documentation ¶
type Documentation struct { // DocumentationRootUrl: The URL to the root of documentation. DocumentationRootUrl string `json:"documentationRootUrl,omitempty"` // Overview: Declares a single overview page. For // example: // <pre><code>documentation: // summary: ... // overview: (== 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. Overview string `json:"overview,omitempty"` // Pages: The top level pages for the documentation set. Pages []*Page `json:"pages,omitempty"` // Rules: A list of documentation rules that apply to individual API // elements. // // **NOTE:** All service configuration rules follow "last one wins" // order. Rules []*DocumentationRule `json:"rules,omitempty"` // Summary: A short summary of what the service does. Can only be // provided by // plain text. Summary string `json:"summary,omitempty"` // ForceSendFields is a list of field names (e.g. // "DocumentationRootUrl") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DocumentationRootUrl") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Documentation: `Documentation` provides the information for describing a service.
Example: <pre><code>documentation:
summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== 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 to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded.
Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided.
A number of constructs specific to the API platform are supported in documentation text.
In order to reference a proto element, the following notation can be used: <pre><code>[fully.qualified.proto.name][]</code></pre> T o override the display text used for the link, this can be used: <pre><code>[display text][fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>(-- internal comment --)</code></pre> Comments can be made conditional using a visibility label. The below text will be only rendered if the `BETA` label is available: <pre><code>(--BETA: comment for BETA users --)</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>(== include path/to/file ==)</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>(== resource_for v1.shelves.books ==)</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.
func (*Documentation) MarshalJSON ¶
func (s *Documentation) MarshalJSON() ([]byte, error)
type DocumentationRule ¶
type DocumentationRule struct { // DeprecationDescription: Deprecation description of the selected // element(s). It can be provided if an // element is marked as `deprecated`. DeprecationDescription string `json:"deprecationDescription,omitempty"` // Description: Description of the selected API(s). Description string `json:"description,omitempty"` // Selector: The selector is a comma-separated list of patterns. Each // pattern is a // qualified name of the element which may end in "*", indicating a // wildcard. // Wildcards are only allowed at the end and for a whole component of // the // qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". // To // specify a default for all applicable elements, the whole pattern // "*" // is used. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. // "DeprecationDescription") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DeprecationDescription") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DocumentationRule: A documentation rule provides information about individual API elements.
func (*DocumentationRule) MarshalJSON ¶
func (s *DocumentationRule) MarshalJSON() ([]byte, error)
type EnableServiceRequest ¶
type EnableServiceRequest struct { // ConsumerId: The identity of consumer resource which service // enablement will be // applied to. // // The Google Service Management implementation accepts the // following // forms: "project:<project_id>", // "project_number:<project_number>". // // Note: this is made compatible // with // google.api.servicecontrol.v1.Operation.consumer_id. ConsumerId string `json:"consumerId,omitempty"` // ForceSendFields is a list of field names (e.g. "ConsumerId") 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. "ConsumerId") 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:"-"` }
EnableServiceRequest: Request message for EnableService method.
func (*EnableServiceRequest) MarshalJSON ¶
func (s *EnableServiceRequest) MarshalJSON() ([]byte, error)
type Endpoint ¶
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 // intented // alias. // // Additional names that this endpoint will be hosted on. Aliases []string `json:"aliases,omitempty"` // AllowCors: // Allowing // [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sh // aring), aka // cross-domain traffic, would allow the backends served from this // endpoint to // receive and respond to HTTP OPTIONS requests. The response will be // used by // the browser to determine whether the subsequent cross-origin request // is // allowed to proceed. AllowCors bool `json:"allowCors,omitempty"` // Apis: The list of APIs served by this endpoint. Apis []string `json:"apis,omitempty"` // Features: The list of features enabled on this endpoint. Features []string `json:"features,omitempty"` // Name: The canonical name of this endpoint. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Aliases") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Aliases") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Endpoint: `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration.
Example service configuration:
name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address
library-example.googleapis.com.
# It also allows HTTP OPTIONS calls to be passed to the
backend, for
# it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com apis: google.example.library.v1.Library allow_cors: true # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address # google.example.library-example.v1.LibraryManager. - name: library-manager.googleapis.com apis: google.example.library.v1.LibraryManager # BNS address for a borg job. Can specify a task by appending # "/taskId" (e.g. "/0") to the job spec.
Example OpenAPI extension for endpoint with allow_cors set to true:
{ "swagger": "2.0", "info": { "description": "A simple..." }, "host": "MY_PROJECT_ID.appspot.com", "x-google-endpoints": [{ "name": "MY_PROJECT_ID.appspot.com", "allow_cors": "true" }] }
func (*Endpoint) MarshalJSON ¶
type Enum ¶
type Enum struct { // Enumvalue: Enum value definitions. Enumvalue []*EnumValue `json:"enumvalue,omitempty"` // Name: Enum type name. Name string `json:"name,omitempty"` // Options: Protocol buffer options. Options []*Option `json:"options,omitempty"` // SourceContext: The source context. SourceContext *SourceContext `json:"sourceContext,omitempty"` // Syntax: The source syntax. // // Possible values: // "SYNTAX_PROTO2" - Syntax `proto2`. // "SYNTAX_PROTO3" - Syntax `proto3`. Syntax string `json:"syntax,omitempty"` // ForceSendFields is a list of field names (e.g. "Enumvalue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Enumvalue") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Enum: Enum type definition.
func (*Enum) MarshalJSON ¶
type EnumValue ¶
type EnumValue struct { // Name: Enum value name. Name string `json:"name,omitempty"` // Number: Enum value number. Number int64 `json:"number,omitempty"` // Options: Protocol buffer options. Options []*Option `json:"options,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EnumValue: Enum value definition.
func (*EnumValue) MarshalJSON ¶
type Field ¶
type Field struct { // Cardinality: The field cardinality. // // Possible values: // "CARDINALITY_UNKNOWN" - For fields with unknown cardinality. // "CARDINALITY_OPTIONAL" - For optional fields. // "CARDINALITY_REQUIRED" - For required fields. Proto2 syntax only. // "CARDINALITY_REPEATED" - For repeated fields. Cardinality string `json:"cardinality,omitempty"` // DefaultValue: The string value of the default value of this field. // Proto2 syntax only. DefaultValue string `json:"defaultValue,omitempty"` // JsonName: The field JSON name. JsonName string `json:"jsonName,omitempty"` // Kind: The field type. // // Possible values: // "TYPE_UNKNOWN" - Field type unknown. // "TYPE_DOUBLE" - Field type double. // "TYPE_FLOAT" - Field type float. // "TYPE_INT64" - Field type int64. // "TYPE_UINT64" - Field type uint64. // "TYPE_INT32" - Field type int32. // "TYPE_FIXED64" - Field type fixed64. // "TYPE_FIXED32" - Field type fixed32. // "TYPE_BOOL" - Field type bool. // "TYPE_STRING" - Field type string. // "TYPE_GROUP" - Field type group. Proto2 syntax only, and // deprecated. // "TYPE_MESSAGE" - Field type message. // "TYPE_BYTES" - Field type bytes. // "TYPE_UINT32" - Field type uint32. // "TYPE_ENUM" - Field type enum. // "TYPE_SFIXED32" - Field type sfixed32. // "TYPE_SFIXED64" - Field type sfixed64. // "TYPE_SINT32" - Field type sint32. // "TYPE_SINT64" - Field type sint64. Kind string `json:"kind,omitempty"` // Name: The field name. Name string `json:"name,omitempty"` // Number: The field number. Number int64 `json:"number,omitempty"` // OneofIndex: The index of the field type in `Type.oneofs`, for message // or enumeration // types. The first type has index 1; zero means the type is not in the // list. OneofIndex int64 `json:"oneofIndex,omitempty"` // Options: The protocol buffer options. Options []*Option `json:"options,omitempty"` // Packed: Whether to use alternative packed wire representation. Packed bool `json:"packed,omitempty"` // TypeUrl: The field type URL, without the scheme, for message or // enumeration // types. Example: "type.googleapis.com/google.protobuf.Timestamp". TypeUrl string `json:"typeUrl,omitempty"` // ForceSendFields is a list of field names (e.g. "Cardinality") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Cardinality") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Field: A single field of a message type.
func (*Field) MarshalJSON ¶
type GenerateConfigReportRequest ¶
type GenerateConfigReportRequest struct { // NewConfig: Service configuration for which we want to generate the // report. // For this version of API, the supported types // are // google.api.servicemanagement.v1.ConfigRef, // google.api.servicemanag // ement.v1.ConfigSource, // and google.api.Service NewConfig GenerateConfigReportRequestNewConfig `json:"newConfig,omitempty"` // OldConfig: Service configuration against which the comparison will be // done. // For this version of API, the supported types // are // google.api.servicemanagement.v1.ConfigRef, // google.api.servicemanag // ement.v1.ConfigSource, // and google.api.Service OldConfig GenerateConfigReportRequestOldConfig `json:"oldConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "NewConfig") 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. "NewConfig") 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:"-"` }
GenerateConfigReportRequest: Request message for GenerateConfigReport method.
func (*GenerateConfigReportRequest) MarshalJSON ¶
func (s *GenerateConfigReportRequest) MarshalJSON() ([]byte, error)
type GenerateConfigReportRequestNewConfig ¶
type GenerateConfigReportRequestNewConfig interface{}
type GenerateConfigReportRequestOldConfig ¶
type GenerateConfigReportRequestOldConfig interface{}
type GenerateConfigReportResponse ¶
type GenerateConfigReportResponse struct { // ChangeReports: list of ChangeReport, each corresponding to comparison // between two // service configurations. ChangeReports []*ChangeReport `json:"changeReports,omitempty"` // Diagnostics: Errors / Linter warnings associated with the service // definition this // report // belongs to. Diagnostics []*Diagnostic `json:"diagnostics,omitempty"` // Id: ID of the service configuration this report belongs to. Id string `json:"id,omitempty"` // ServiceName: Name of the service this report belongs to. ServiceName string `json:"serviceName,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ChangeReports") 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. "ChangeReports") 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:"-"` }
GenerateConfigReportResponse: Response message for GenerateConfigReport method.
func (*GenerateConfigReportResponse) MarshalJSON ¶
func (s *GenerateConfigReportResponse) MarshalJSON() ([]byte, error)
type GetIamPolicyRequest ¶
type GetIamPolicyRequest struct { }
GetIamPolicyRequest: Request message for `GetIamPolicy` method.
type Http ¶
type Http struct { // 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. "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:"-"` }
Http: Defines the HTTP configuration for a service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
func (*Http) MarshalJSON ¶
type HttpRule ¶
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 // body, or // `*` for mapping all fields not captured by the path pattern to the // HTTP // body. NOTE: the referred field must not be a repeated field and must // be // present at the top-level of response message type. Body string `json:"body,omitempty"` // Custom: Custom pattern is used for defining custom verbs. Custom *CustomHttpPattern `json:"custom,omitempty"` // Delete: Used for deleting a resource. Delete string `json:"delete,omitempty"` // Get: Used for listing and getting information about resources. Get string `json:"get,omitempty"` // MediaDownload: Do not use this. For media support, add // instead // [][google.bytestream.RestByteStream] as an API to your // configuration. MediaDownload *MediaDownload `json:"mediaDownload,omitempty"` // MediaUpload: Do not use this. For media support, add // instead // [][google.bytestream.RestByteStream] as an API to your // configuration. MediaUpload *MediaUpload `json:"mediaUpload,omitempty"` // Patch: Used for updating a resource. Patch string `json:"patch,omitempty"` // Post: Used for creating a resource. Post string `json:"post,omitempty"` // Put: Used for updating a resource. Put string `json:"put,omitempty"` // ResponseBody: The name of the response field whose value is mapped to // the HTTP body of // response. Other response fields are ignored. This field is optional. // When // not set, the response message will be used as HTTP body of // response. // NOTE: the referred field must be not a repeated field and must be // present // at the top-level of response message type. ResponseBody string `json:"responseBody,omitempty"` // Selector: Selects methods to which this rule applies. // // Refer to selector for syntax details. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. "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: `HttpRule` defines the mapping of an RPC method to one or more HTTP REST APIs. The mapping determines what portions of the request message are populated from the path, query parameters, or body of the HTTP request. The mapping is typically specified as an `google.api.http` annotation, see "google/api/annotations.proto" for details.
The mapping consists of a field specifying the path template and method kind. The path template can refer to fields in the request message, as in the example below which describes a REST GET operation on a resource collection of messages:
```proto
service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http).get =
"/v1/messages/{message_id}/{sub.subfield}";
} }
message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // mapped to the URL SubMessage sub = 2; // `sub.subfield` is url-mapped }
message Message { string text = 1; // content of the resource }
```
This definition enables an automatic, bidrectional mapping of HTTP JSON to RPC. Example:
HTTP | RPC -----|----- `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
In general, not only fields but also field paths can be referenced from a path pattern. Fields mapped to the path pattern cannot be repeated and must have a primitive (non-message) type.
Any fields in the request message which are not bound by the path pattern automatically become (optional) HTTP query parameters. Assume the following definition of the request message:
```proto
message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // mapped to the URL int64 revision = 2; // becomes a parameter SubMessage sub = 3; // `sub.subfield` becomes a
parameter } ```
This enables a HTTP JSON to RPC mapping as below:
HTTP | RPC -----|----- `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 HTTP parameters must have a primitive type or a repeated primitive type. Message types are not allowed. In the case of a repeated type, the parameter can be repeated in the URL, as in `...?param=A¶m=B`.
For HTTP method kinds which allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection:
```proto
service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { put: "/v1/messages/{message_id}" body: "message" }; } }
message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body }
```
The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding:
HTTP | RPC -----|----- `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method:
```proto
service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { put: "/v1/messages/{message_id}" body: "*" }; } }
message Message { string message_id = 1; string text = 2; }
```
The following HTTP JSON to RPC mapping is enabled:
HTTP | RPC -----|----- `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice of defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data.
It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example:
```proto
service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } }
message GetMessageRequest { string message_id = 1; string user_id = 2; }
```
This enables the following two alternative HTTP JSON to RPC mappings:
HTTP | RPC -----|----- `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 ¶
The rules for mapping HTTP path, query parameters, and body fields to the request message are as follows:
- The `body` field specifies either `*` or a field path, or is omitted. If omitted, it assumes there is no HTTP body.
- Leaf fields (recursive expansion of nested messages in the request) can be classified into three types: (a) Matched in the URL template. (b) Covered by body (if body is `*`, everything except (a)
fields;
else everything under the body field) (c) All other fields.
3. URL query parameters found in the HTTP request are mapped to (c) fields. 4. Any body sent with an HTTP request can contain only (b) fields.
The syntax of the path template is as follows:
Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ;
The syntax `*` matches a single path segment. It follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion.
The syntax `**` matches zero or more path segments. It follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved Expansion.
The syntax `LITERAL` matches literal text in the URL path.
The syntax `Variable` matches the entire path as specified by its template; this nested template must not contain further variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`.
NOTE: the field paths in variables and in the `body` must not refer to repeated fields or map fields.
Use CustomHttpPattern to specify any HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for a given URL path rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.
func (*HttpRule) MarshalJSON ¶
type LabelDescriptor ¶
type LabelDescriptor struct { // Description: A human-readable description for the label. Description string `json:"description,omitempty"` // Key: The label key. Key string `json:"key,omitempty"` // ValueType: The type of data that can be assigned to the label. // // Possible values: // "STRING" - A variable-length string. This is the default. // "BOOL" - Boolean; true or false. // "INT64" - A 64-bit signed integer. ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
LabelDescriptor: A description of a label.
func (*LabelDescriptor) MarshalJSON ¶
func (s *LabelDescriptor) MarshalJSON() ([]byte, error)
type ListServiceConfigsResponse ¶
type ListServiceConfigsResponse struct { // NextPageToken: The token of the next page of results. NextPageToken string `json:"nextPageToken,omitempty"` // ServiceConfigs: The list of service configuration resources. ServiceConfigs []*Service `json:"serviceConfigs,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:"-"` }
ListServiceConfigsResponse: Response message for ListServiceConfigs method.
func (*ListServiceConfigsResponse) MarshalJSON ¶
func (s *ListServiceConfigsResponse) MarshalJSON() ([]byte, error)
type ListServiceRolloutsResponse ¶
type ListServiceRolloutsResponse struct { // NextPageToken: The token of the next page of results. NextPageToken string `json:"nextPageToken,omitempty"` // Rollouts: The list of rollout resources. Rollouts []*Rollout `json:"rollouts,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:"-"` }
ListServiceRolloutsResponse: Response message for ListServiceRollouts method.
func (*ListServiceRolloutsResponse) MarshalJSON ¶
func (s *ListServiceRolloutsResponse) MarshalJSON() ([]byte, error)
type ListServicesResponse ¶
type ListServicesResponse struct { // NextPageToken: Token that can be passed to `ListServices` to resume a // paginated query. NextPageToken string `json:"nextPageToken,omitempty"` // Services: The results of the query. Services []*ManagedService `json:"services,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListServicesResponse: Response message for `ListServices` method.
func (*ListServicesResponse) MarshalJSON ¶
func (s *ListServicesResponse) MarshalJSON() ([]byte, error)
type LogConfig ¶
type LogConfig struct { // CloudAudit: Cloud audit options. CloudAudit *CloudAuditOptions `json:"cloudAudit,omitempty"` // Counter: Counter options. Counter *CounterOptions `json:"counter,omitempty"` // DataAccess: Data access options. DataAccess *DataAccessOptions `json:"dataAccess,omitempty"` // ForceSendFields is a list of field names (e.g. "CloudAudit") 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. "CloudAudit") 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:"-"` }
LogConfig: Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names.
Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.
Field names correspond to IAM request parameters and field values are their respective values.
At present the only supported field names are
- "iam_principal", corresponding to IAMContext.principal;
- "" (empty string), resulting in one aggretated counter with no
field.
Examples:
counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of
IAMContext.principal]}
At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
func (*LogConfig) MarshalJSON ¶
type LogDescriptor ¶
type LogDescriptor struct { // Description: A human-readable description of this log. This // information appears in // the documentation and can contain details. Description string `json:"description,omitempty"` // DisplayName: The human-readable name for this log. This information // appears on // the user interface and should be concise. DisplayName string `json:"displayName,omitempty"` // Labels: The set of labels that are available to describe a specific // log entry. // Runtime requests that contain labels not specified here // are // considered invalid. Labels []*LabelDescriptor `json:"labels,omitempty"` // Name: The name of the log. It must be less than 512 characters long // and can // include the following characters: upper- and lower-case // alphanumeric // characters [A-Za-z0-9], and punctuation characters including // slash, underscore, hyphen, period [/_-.]. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
LogDescriptor: A description of a log type. Example in YAML format:
- name: library.googleapis.com/activity_history description: The history of borrowing and returning library
items.
display_name: Activity labels: - key: /customer_id description: Identifier of a library customer
func (*LogDescriptor) MarshalJSON ¶
func (s *LogDescriptor) MarshalJSON() ([]byte, error)
type Logging ¶
type Logging struct { // ConsumerDestinations: Logging configurations for sending logs to the // consumer project. // There can be multiple consumer destinations, each one must have // a // different monitored resource type. A log can be used in at most // one consumer destination. ConsumerDestinations []*LoggingDestination `json:"consumerDestinations,omitempty"` // ProducerDestinations: Logging configurations for sending logs to the // producer project. // There can be multiple producer destinations, each one must have // a // different monitored resource type. A log can be used in at most // one producer destination. ProducerDestinations []*LoggingDestination `json:"producerDestinations,omitempty"` // ForceSendFields is a list of field names (e.g. // "ConsumerDestinations") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConsumerDestinations") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Logging: Logging configuration of the service.
The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project.
monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located
in.
- key: /name description: The name of the branch. logs:
- name: activity_history labels:
- key: /customer_id
- name: purchase_history logging: producer_destinations:
- monitored_resource: library.googleapis.com/branch logs:
- activity_history
- purchase_history consumer_destinations:
- monitored_resource: library.googleapis.com/branch logs:
- activity_history
func (*Logging) MarshalJSON ¶
type LoggingDestination ¶
type LoggingDestination struct { // Logs: Names of the logs to be sent to this destination. Each name // must // be defined in the Service.logs section. If the log name is // not a domain scoped name, it will be automatically prefixed with // the service name followed by "/". Logs []string `json:"logs,omitempty"` // MonitoredResource: The monitored resource type. The type must be // defined in the // Service.monitored_resources section. MonitoredResource string `json:"monitoredResource,omitempty"` // ForceSendFields is a list of field names (e.g. "Logs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Logs") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
LoggingDestination: Configuration of a specific logging destination (the producer project or the consumer project).
func (*LoggingDestination) MarshalJSON ¶
func (s *LoggingDestination) MarshalJSON() ([]byte, error)
type ManagedService ¶
type ManagedService struct { // ProducerProjectId: ID of the project that produces and owns this // service. ProducerProjectId string `json:"producerProjectId,omitempty"` // ServiceName: The name of the service. See the // [overview](/service-management/overview) // for naming requirements. ServiceName string `json:"serviceName,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ProducerProjectId") // 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. "ProducerProjectId") 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:"-"` }
ManagedService: The full representation of a Service that is managed by Google Service Management.
func (*ManagedService) MarshalJSON ¶
func (s *ManagedService) MarshalJSON() ([]byte, error)
type MediaDownload ¶
type MediaDownload struct { // Enabled: Whether download is enabled. Enabled bool `json:"enabled,omitempty"` // ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"` }
MediaDownload: Do not use this. For media support, add instead [][google.bytestream.RestByteStream] as an API to your configuration.
func (*MediaDownload) MarshalJSON ¶
func (s *MediaDownload) MarshalJSON() ([]byte, error)
type MediaUpload ¶
type MediaUpload struct { // Enabled: Whether upload is enabled. Enabled bool `json:"enabled,omitempty"` // ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"` }
MediaUpload: Do not use this. For media support, add instead [][google.bytestream.RestByteStream] as an API to your configuration.
func (*MediaUpload) MarshalJSON ¶
func (s *MediaUpload) MarshalJSON() ([]byte, error)
type Method ¶
type Method struct { // Name: The simple name of this method. Name string `json:"name,omitempty"` // Options: Any metadata attached to the method. Options []*Option `json:"options,omitempty"` // RequestStreaming: If true, the request is streamed. RequestStreaming bool `json:"requestStreaming,omitempty"` // RequestTypeUrl: A URL of the input message type. RequestTypeUrl string `json:"requestTypeUrl,omitempty"` // ResponseStreaming: If true, the response is streamed. ResponseStreaming bool `json:"responseStreaming,omitempty"` // ResponseTypeUrl: The URL of the output message type. ResponseTypeUrl string `json:"responseTypeUrl,omitempty"` // Syntax: The source syntax of this method. // // Possible values: // "SYNTAX_PROTO2" - Syntax `proto2`. // "SYNTAX_PROTO3" - Syntax `proto3`. Syntax string `json:"syntax,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Method: Method represents a method of an api.
func (*Method) MarshalJSON ¶
type MetricDescriptor ¶
type MetricDescriptor struct { // Description: A detailed description of the metric, which can be used // in documentation. Description string `json:"description,omitempty"` // DisplayName: A concise name for the metric, which can be displayed in // user interfaces. // Use sentence case without an ending period, for example "Request // count". DisplayName string `json:"displayName,omitempty"` // Labels: The set of labels that can be used to describe a specific // instance of this // metric type. For example, // the // `compute.googleapis.com/instance/network/received_bytes_count` metric // type // has a label, `loadbalanced`, that specifies whether the traffic // was // received through a load balanced IP address. Labels []*LabelDescriptor `json:"labels,omitempty"` // MetricKind: Whether the metric records instantaneous values, changes // to a value, etc. // Some combinations of `metric_kind` and `value_type` might not be // supported. // // Possible values: // "METRIC_KIND_UNSPECIFIED" - Do not use this default value. // "GAUGE" - An instantaneous measurement of a value. // "DELTA" - The change in a value during a time interval. // "CUMULATIVE" - A value accumulated over a time interval. // Cumulative // measurements in a time series should have the same start time // and increasing end times, until an event resets the cumulative // value to zero and sets a new start time for the following // points. MetricKind string `json:"metricKind,omitempty"` // Name: Resource name. The format of the name may vary between // different // implementations. For examples: // // projects/{project_id}/metricDescriptors/{type=**} // metricDescriptors/{type=**} Name string `json:"name,omitempty"` // Type: The metric type including a DNS name prefix, for // example // "compute.googleapis.com/instance/cpu/utilization". Metric // types // should use a natural hierarchical grouping such as the following: // // compute.googleapis.com/instance/cpu/utilization // compute.googleapis.com/instance/disk/read_ops_count // // compute.googleapis.com/instance/network/received_bytes_count // // Note that if the metric type changes, the monitoring data will // be // discontinued, and anything depends on it will break, such as // monitoring // dashboards, alerting rules and quota limits. Therefore, once a metric // has // been published, its type should be immutable. Type string `json:"type,omitempty"` // Unit: The unit in which the metric value is reported. It is only // applicable // if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. // The // supported units are a subset of [The Unified Code for Units // of // Measure](http://unitsofmeasure.org/ucum.html) standard: // // **Basic units (UNIT)** // // * `bit` bit // * `By` byte // * `s` second // * `min` minute // * `h` hour // * `d` day // // **Prefixes (PREFIX)** // // * `k` kilo (10**3) // * `M` mega (10**6) // * `G` giga (10**9) // * `T` tera (10**12) // * `P` peta (10**15) // * `E` exa (10**18) // * `Z` zetta (10**21) // * `Y` yotta (10**24) // * `m` milli (10**-3) // * `u` micro (10**-6) // * `n` nano (10**-9) // * `p` pico (10**-12) // * `f` femto (10**-15) // * `a` atto (10**-18) // * `z` zepto (10**-21) // * `y` yocto (10**-24) // * `Ki` kibi (2**10) // * `Mi` mebi (2**20) // * `Gi` gibi (2**30) // * `Ti` tebi (2**40) // // **Grammar** // // The grammar includes the dimensionless unit `1`, such as `1/s`. // // 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 '}'. Unit string `json:"unit,omitempty"` // ValueType: Whether the measurement is an integer, a floating-point // number, etc. // Some combinations of `metric_kind` and `value_type` might not be // supported. // // Possible values: // "VALUE_TYPE_UNSPECIFIED" - Do not use this default value. // "BOOL" - The value is a boolean. // This value type can be used only if the metric kind is `GAUGE`. // "INT64" - The value is a signed 64-bit integer. // "DOUBLE" - The value is a double precision floating point number. // "STRING" - The value is a text string. // This value type can be used only if the metric kind is `GAUGE`. // "DISTRIBUTION" - The value is a `Distribution`. // "MONEY" - The value is money. ValueType string `json:"valueType,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
MetricDescriptor: Defines a metric type and its schema.
func (*MetricDescriptor) MarshalJSON ¶
func (s *MetricDescriptor) MarshalJSON() ([]byte, error)
type Mixin ¶
type Mixin struct { // Name: The fully qualified name of the API which is included. Name string `json:"name,omitempty"` // Root: If non-empty specifies a path under which inherited HTTP // paths // are rooted. Root string `json:"root,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Mixin: Declares an API to be included in this API. The including API must redeclare all the methods from the included API, but documentation and options are inherited as follows:
- If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.
- Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited.
- If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including API plus the root path if
specified.
Example of a simple mixin:
package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } }
Example of a mixin configuration:
apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl
The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows:
service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... }
Note how the version in the path pattern changed from `v1` to `v2`.
If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example:
apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls
This implies the following inherited HTTP annotation:
service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get =
"/v2/acls/{resource=**}:getAcl";
} ... }
func (*Mixin) MarshalJSON ¶
type MonitoredResourceDescriptor ¶
type MonitoredResourceDescriptor struct { // Description: Optional. A detailed description of the monitored // resource type that might // be used in documentation. Description string `json:"description,omitempty"` // DisplayName: Optional. A concise name for the monitored resource type // that might be // displayed in user interfaces. It should be a Title Cased Noun // Phrase, // without any article or other determiners. For example, // "Google Cloud SQL Database". DisplayName string `json:"displayName,omitempty"` // Labels: Required. A set of labels used to describe instances of this // monitored // resource type. For example, an individual Google Cloud SQL database // is // identified by values for the labels "database_id" and "zone". Labels []*LabelDescriptor `json:"labels,omitempty"` // Name: Optional. The resource name of the monitored resource // descriptor: // "projects/{project_id}/monitoredResourceDescriptors/{type // }" where // {type} is the value of the `type` field in this object // and // {project_id} is a project ID that provides API-specific context // for // accessing the type. APIs that do not use project information can use // the // resource name format "monitoredResourceDescriptors/{type}". Name string `json:"name,omitempty"` // Type: Required. The monitored resource type. For example, the // type // "cloudsql_database" represents databases in Google Cloud SQL. // The maximum length of this value is 256 characters. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
MonitoredResourceDescriptor: An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.
Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.
func (*MonitoredResourceDescriptor) MarshalJSON ¶
func (s *MonitoredResourceDescriptor) MarshalJSON() ([]byte, error)
type Monitoring ¶
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 and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project.
monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located
in.
- key: /name description: The name of the branch. metrics:
- name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels:
- key: /customer_id
- name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels:
- key: /customer_id monitoring: producer_destinations:
- monitored_resource: library.googleapis.com/branch metrics:
- library.googleapis.com/book/returned_count consumer_destinations:
- monitored_resource: library.googleapis.com/branch metrics:
- library.googleapis.com/book/returned_count
- library.googleapis.com/book/overdue_count
func (*Monitoring) MarshalJSON ¶
func (s *Monitoring) MarshalJSON() ([]byte, error)
type MonitoringDestination ¶
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. MonitoredResource string `json:"monitoredResource,omitempty"` // ForceSendFields is a list of field names (e.g. "Metrics") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metrics") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
MonitoringDestination: Configuration of a specific monitoring destination (the producer project or the consumer project).
func (*MonitoringDestination) MarshalJSON ¶
func (s *MonitoringDestination) MarshalJSON() ([]byte, error)
type OAuthRequirements ¶
type OAuthRequirements struct { // CanonicalScopes: The list of publicly documented OAuth scopes that // are allowed access. An // OAuth token containing any of these scopes will be // accepted. // // Example: // // canonical_scopes: https://www.googleapis.com/auth/calendar, // https://www.googleapis.com/auth/calendar.read CanonicalScopes string `json:"canonicalScopes,omitempty"` // ForceSendFields is a list of field names (e.g. "CanonicalScopes") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CanonicalScopes") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
OAuthRequirements: OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf.
OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means.
In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs.
When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice.
Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.
func (*OAuthRequirements) MarshalJSON ¶
func (s *OAuthRequirements) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. // If true, the operation is completed, and either `error` or `response` // is // available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. // It typically // contains progress information and common metadata such as create // time. // Some services might not provide such metadata. Any method that // returns a // long-running operation should document the metadata type, if any. Metadata OperationMetadata `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`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. // If the original // method returns no data on success, such as `Delete`, the response // is // `google.protobuf.Empty`. If the original method is // standard // `Get`/`Create`/`Update`, the response should be the resource. For // other // methods, the response should have the type `XxxResponse`, where // `Xxx` // is the original method name. For example, if the original method // name // is `TakeSnapshot()`, the inferred response type // is // `TakeSnapshotResponse`. Response OperationResponse `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Done") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type OperationMetadata ¶
type OperationMetadata interface{}
type OperationMetadata1 ¶
type OperationMetadata1 struct { // ProgressPercentage: Percentage of completion of this operation, // ranging from 0 to 100. ProgressPercentage int64 `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. StartTime string `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:"-"` }
OperationMetadata1: The metadata associated with a long running operation resource.
func (*OperationMetadata1) MarshalJSON ¶
func (s *OperationMetadata1) MarshalJSON() ([]byte, error)
type OperationResponse ¶
type OperationResponse interface{}
type OperationsGetCall ¶
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (*OperationsGetCall) Context ¶
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsGetCall) Do ¶
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "servicemanagement.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsGetCall) Fields ¶
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsGetCall) IfNoneMatch ¶
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type OperationsService ¶
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶
func NewOperationsService(s *APIService) *OperationsService
func (*OperationsService) Get ¶
func (r *OperationsService) Get(name string) *OperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
type Option ¶
type Option struct { // Name: The option's name. For example, "java_package". Name string `json:"name,omitempty"` // Value: The option's value. For example, "com.google.protobuf". Value OptionValue `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 ¶
type OptionValue ¶
type OptionValue interface{}
type Page ¶
type Page struct { // Content: The Markdown content of the page. You can use <code>(== // include {path} ==)</code> // to include content from a Markdown file. Content string `json:"content,omitempty"` // Name: The name of the page. It will be used as an identity of the // page to // generate URI of the page, text of the link to this page in // navigation, // etc. The full page name (start from the root page name to this // page // concatenated with `.`) can be used as reference to the page in // your // documentation. For example: // <pre><code>pages: // - name: Tutorial // content: (== include tutorial.md ==) // subpages: // - name: Java // content: (== include tutorial_java.md // ==) // </code></pre> // You can reference `Java` page using Markdown reference link // syntax: // `Java`. Name string `json:"name,omitempty"` // Subpages: Subpages of this page. The order of subpages specified here // will be // honored in the generated docset. Subpages []*Page `json:"subpages,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Content") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Page: Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
func (*Page) MarshalJSON ¶
type Policy ¶
type Policy struct { // AuditConfigs: Specifies audit logging configs for "data // access". // "data access": generally refers to data reads/writes and admin // reads. // "admin activity": generally refers to admin writes. // // Note: `AuditConfig` doesn't apply to "admin activity", which // always // enables audit logging. AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"` // Bindings: Associates a list of `members` to a `role`. // Multiple `bindings` must not be specified for the same // `role`. // `bindings` with no members will result in an error. Bindings []*Binding `json:"bindings,omitempty"` // Etag: `etag` is used for optimistic concurrency control as a way to // help // prevent simultaneous updates of a policy from overwriting each // other. // It is strongly suggested that systems make use of the `etag` in // the // read-modify-write cycle to perform policy updates in order to avoid // race // conditions: An `etag` is returned in the response to `getIamPolicy`, // and // systems are expected to put that etag in the request to // `setIamPolicy` to // ensure that their change will be applied to the same version of the // policy. // // If no `etag` is provided in the call to `setIamPolicy`, then the // existing // policy is overwritten blindly. Etag string `json:"etag,omitempty"` IamOwned bool `json:"iamOwned,omitempty"` // Rules: If more than one rule is specified, the rules are applied in // the following // manner: // - All matching LOG rules are always applied. // - If any DENY/DENY_WITH_LOG rule matches, permission is denied. // Logging will be applied if one or more matching rule requires // logging. // - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is // granted. // Logging will be applied if one or more matching rule requires // logging. // - Otherwise, if no rule applies, permission is denied. Rules []*Rule `json:"rules,omitempty"` // Version: Version of the `Policy`. The default version is 0. Version int64 `json:"version,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AuditConfigs") 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. "AuditConfigs") 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:"-"` }
Policy: Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
**Example**
{ "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com",
"serviceAccount:my-other-app@appspot.gserviceaccount.com",
] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
func (*Policy) MarshalJSON ¶
type Rollout ¶
type Rollout struct { // CreateTime: Creation time of the rollout. Readonly. CreateTime string `json:"createTime,omitempty"` // CreatedBy: The user who created the Rollout. Readonly. CreatedBy string `json:"createdBy,omitempty"` // DeleteServiceStrategy: The strategy associated with a rollout to // delete a `ManagedService`. // Readonly. DeleteServiceStrategy *DeleteServiceStrategy `json:"deleteServiceStrategy,omitempty"` // RolloutId: Optional unique identifier of this Rollout. Only lower // case letters, digits // and '-' are allowed. // // If not specified by client, the server will generate one. The // generated id // will have the form of <date><revision number>, where "date" is the // create // date in ISO 8601 format. "revision number" is a monotonically // increasing // positive number that is reset every day for each service. // An example of the generated rollout_id is '2016-02-16r1' RolloutId string `json:"rolloutId,omitempty"` // ServiceName: The name of the service associated with this Rollout. ServiceName string `json:"serviceName,omitempty"` // Status: The status of this rollout. Readonly. In case of a failed // rollout, // the system will automatically rollback to the current // Rollout // version. Readonly. // // Possible values: // "ROLLOUT_STATUS_UNSPECIFIED" - No status specified. // "IN_PROGRESS" - The Rollout is in progress. // "SUCCESS" - The Rollout has completed successfully. // "CANCELLED" - The Rollout has been cancelled. This can happen if // you have overlapping // Rollout pushes, and the previous ones will be cancelled. // "FAILED" - The Rollout has failed. It is typically caused by // configuration errors. // "PENDING" - The Rollout has not started yet and is pending for // execution. Status string `json:"status,omitempty"` // TrafficPercentStrategy: Google Service Control selects service // configurations based on // traffic percentage. TrafficPercentStrategy *TrafficPercentStrategy `json:"trafficPercentStrategy,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"` }
Rollout: A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config.
func (*Rollout) MarshalJSON ¶
type Rule ¶
type Rule struct { // Action: Required // // Possible values: // "NO_ACTION" - Default no action. // "ALLOW" - Matching 'Entries' grant access. // "ALLOW_WITH_LOG" - Matching 'Entries' grant access and the caller // promises to log // the request per the returned log_configs. // "DENY" - Matching 'Entries' deny access. // "DENY_WITH_LOG" - Matching 'Entries' deny access and the caller // promises to log // the request per the returned log_configs. // "LOG" - Matching 'Entries' tell IAM.Check callers to generate logs. Action string `json:"action,omitempty"` // Conditions: Additional restrictions that must be met Conditions []*Condition `json:"conditions,omitempty"` // Description: Human-readable description of the rule. Description string `json:"description,omitempty"` // In: If one or more 'in' clauses are specified, the rule matches // if // the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. In []string `json:"in,omitempty"` // LogConfig: The config returned to callers of tech.iam.IAM.CheckPolicy // for any entries // that match the LOG action. LogConfig []*LogConfig `json:"logConfig,omitempty"` // NotIn: If one or more 'not_in' clauses are specified, the rule // matches // if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. // The format for in and not_in entries is the same as for members in // a // Binding (see google/iam/v1/policy.proto). NotIn []string `json:"notIn,omitempty"` // Permissions: A permission is a string of form '<service>.<resource // type>.<verb>' // (e.g., 'storage.buckets.list'). A value of '*' matches all // permissions, // and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. Permissions []string `json:"permissions,omitempty"` // ForceSendFields is a list of field names (e.g. "Action") 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. "Action") 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:"-"` }
Rule: A rule to be applied in a Policy.
func (*Rule) MarshalJSON ¶
type Service ¶
type Service struct { // Analytics: WARNING: DO NOT USE UNTIL THIS MESSAGE IS // REMOVED. // // Analytics configuration. Analytics *Analytics `json:"analytics,omitempty"` // 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"` // ConfigVersion: The version of the service configuration. The config // version may // influence interpretation of the configuration, for example, // to // determine defaults. This is documented together with // applicable // options. The current default for the config version itself is `3`. ConfigVersion int64 `json:"configVersion,omitempty"` // Context: Context configuration. Context *Context `json:"context,omitempty"` // Control: Configuration for the service control plane. Control *Control `json:"control,omitempty"` // CustomError: Custom error configuration. CustomError *CustomError `json:"customError,omitempty"` // Documentation: Additional API documentation. Documentation *Documentation `json:"documentation,omitempty"` // Endpoints: Configuration for network endpoints. If this is empty, // then an endpoint // with the same name as the service is automatically generated to // service all // defined APIs. Endpoints []*Endpoint `json:"endpoints,omitempty"` // Enums: A list of all enum types included in this API service. // Enums // referenced directly or indirectly by the `apis` are // automatically // included. Enums which are not referenced but shall be // included // should be listed here by name. Example: // // enums: // - name: google.someapi.v1.SomeEnum Enums []*Enum `json:"enums,omitempty"` // Http: HTTP configuration. Http *Http `json:"http,omitempty"` // Id: A unique ID for a specific instance of this message, typically // assigned // by the client for tracking purpose. If empty, the server may choose // to // generate one instead. Id string `json:"id,omitempty"` // Logging: Logging configuration. Logging *Logging `json:"logging,omitempty"` // Logs: Defines the logs used by this service. Logs []*LogDescriptor `json:"logs,omitempty"` // Metrics: Defines the metrics used by this service. Metrics []*MetricDescriptor `json:"metrics,omitempty"` // MonitoredResources: Defines the monitored resources used by this // service. This is required // by the Service.monitoring and Service.logging configurations. MonitoredResources []*MonitoredResourceDescriptor `json:"monitoredResources,omitempty"` // Monitoring: Monitoring configuration. Monitoring *Monitoring `json:"monitoring,omitempty"` // Name: The DNS address at which this service is available, // e.g. `calendar.googleapis.com`. Name string `json:"name,omitempty"` // ProducerProjectId: The id of the Google developer project that owns // the service. // Members of this project can manage the service configuration, // manage consumption of the service, etc. ProducerProjectId string `json:"producerProjectId,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 associated with this service. Title string `json:"title,omitempty"` // Types: A list of all proto message types included in this API // service. // Types referenced directly or indirectly by the `apis` // are // automatically included. Messages which are not referenced but // shall be included, such as types used by the `google.protobuf.Any` // type, // should be listed here by name. Example: // // types: // - name: google.protobuf.Int32 Types []*Type `json:"types,omitempty"` // Usage: Configuration controlling usage of this service. Usage *Usage `json:"usage,omitempty"` // Visibility: API visibility configuration. Visibility *Visibility `json:"visibility,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Analytics") 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. "Analytics") 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 configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details.
Example:
type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com
func (*Service) MarshalJSON ¶
type ServicesConfigsCreateCall ¶
type ServicesConfigsCreateCall struct {
// contains filtered or unexported fields
}
func (*ServicesConfigsCreateCall) Context ¶
func (c *ServicesConfigsCreateCall) Context(ctx context.Context) *ServicesConfigsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesConfigsCreateCall) Do ¶
func (c *ServicesConfigsCreateCall) Do(opts ...googleapi.CallOption) (*Service, error)
Do executes the "servicemanagement.services.configs.create" call. Exactly one of *Service or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Service.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesConfigsCreateCall) Fields ¶
func (c *ServicesConfigsCreateCall) Fields(s ...googleapi.Field) *ServicesConfigsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesConfigsGetCall ¶
type ServicesConfigsGetCall struct {
// contains filtered or unexported fields
}
func (*ServicesConfigsGetCall) Context ¶
func (c *ServicesConfigsGetCall) Context(ctx context.Context) *ServicesConfigsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesConfigsGetCall) Do ¶
func (c *ServicesConfigsGetCall) Do(opts ...googleapi.CallOption) (*Service, error)
Do executes the "servicemanagement.services.configs.get" call. Exactly one of *Service or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Service.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesConfigsGetCall) Fields ¶
func (c *ServicesConfigsGetCall) Fields(s ...googleapi.Field) *ServicesConfigsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ServicesConfigsGetCall) IfNoneMatch ¶
func (c *ServicesConfigsGetCall) IfNoneMatch(entityTag string) *ServicesConfigsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ServicesConfigsListCall ¶
type ServicesConfigsListCall struct {
// contains filtered or unexported fields
}
func (*ServicesConfigsListCall) Context ¶
func (c *ServicesConfigsListCall) Context(ctx context.Context) *ServicesConfigsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesConfigsListCall) Do ¶
func (c *ServicesConfigsListCall) Do(opts ...googleapi.CallOption) (*ListServiceConfigsResponse, error)
Do executes the "servicemanagement.services.configs.list" call. Exactly one of *ListServiceConfigsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListServiceConfigsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesConfigsListCall) Fields ¶
func (c *ServicesConfigsListCall) Fields(s ...googleapi.Field) *ServicesConfigsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ServicesConfigsListCall) IfNoneMatch ¶
func (c *ServicesConfigsListCall) IfNoneMatch(entityTag string) *ServicesConfigsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ServicesConfigsListCall) PageSize ¶
func (c *ServicesConfigsListCall) PageSize(pageSize int64) *ServicesConfigsListCall
PageSize sets the optional parameter "pageSize": The max number of items to include in the response list.
func (*ServicesConfigsListCall) PageToken ¶
func (c *ServicesConfigsListCall) PageToken(pageToken string) *ServicesConfigsListCall
PageToken sets the optional parameter "pageToken": The token of the page to retrieve.
func (*ServicesConfigsListCall) Pages ¶
func (c *ServicesConfigsListCall) Pages(ctx context.Context, f func(*ListServiceConfigsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ServicesConfigsService ¶
type ServicesConfigsService struct {
// contains filtered or unexported fields
}
func NewServicesConfigsService ¶
func NewServicesConfigsService(s *APIService) *ServicesConfigsService
func (*ServicesConfigsService) Create ¶
func (r *ServicesConfigsService) Create(serviceName string, service *Service) *ServicesConfigsCreateCall
Create: Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout.
func (*ServicesConfigsService) Get ¶
func (r *ServicesConfigsService) Get(serviceName string, configId string) *ServicesConfigsGetCall
Get: Gets a service configuration (version) for a managed service.
func (*ServicesConfigsService) List ¶
func (r *ServicesConfigsService) List(serviceName string) *ServicesConfigsListCall
List: Lists the history of the service configuration for a managed service, from the newest to the oldest.
func (*ServicesConfigsService) Submit ¶
func (r *ServicesConfigsService) Submit(serviceName string, submitconfigsourcerequest *SubmitConfigSourceRequest) *ServicesConfigsSubmitCall
Submit: Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout.
Operation<response: SubmitConfigSourceResponse>
type ServicesConfigsSubmitCall ¶
type ServicesConfigsSubmitCall struct {
// contains filtered or unexported fields
}
func (*ServicesConfigsSubmitCall) Context ¶
func (c *ServicesConfigsSubmitCall) Context(ctx context.Context) *ServicesConfigsSubmitCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesConfigsSubmitCall) Do ¶
func (c *ServicesConfigsSubmitCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "servicemanagement.services.configs.submit" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesConfigsSubmitCall) Fields ¶
func (c *ServicesConfigsSubmitCall) Fields(s ...googleapi.Field) *ServicesConfigsSubmitCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesCreateCall ¶
type ServicesCreateCall struct {
// contains filtered or unexported fields
}
func (*ServicesCreateCall) Context ¶
func (c *ServicesCreateCall) Context(ctx context.Context) *ServicesCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesCreateCall) Do ¶
func (c *ServicesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "servicemanagement.services.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesCreateCall) Fields ¶
func (c *ServicesCreateCall) Fields(s ...googleapi.Field) *ServicesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesDeleteCall ¶
type ServicesDeleteCall struct {
// contains filtered or unexported fields
}
func (*ServicesDeleteCall) Context ¶
func (c *ServicesDeleteCall) Context(ctx context.Context) *ServicesDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesDeleteCall) Do ¶
func (c *ServicesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "servicemanagement.services.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesDeleteCall) Fields ¶
func (c *ServicesDeleteCall) Fields(s ...googleapi.Field) *ServicesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesDisableCall ¶
type ServicesDisableCall struct {
// contains filtered or unexported fields
}
func (*ServicesDisableCall) Context ¶
func (c *ServicesDisableCall) Context(ctx context.Context) *ServicesDisableCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesDisableCall) Do ¶
func (c *ServicesDisableCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "servicemanagement.services.disable" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesDisableCall) Fields ¶
func (c *ServicesDisableCall) Fields(s ...googleapi.Field) *ServicesDisableCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesEnableCall ¶
type ServicesEnableCall struct {
// contains filtered or unexported fields
}
func (*ServicesEnableCall) Context ¶
func (c *ServicesEnableCall) Context(ctx context.Context) *ServicesEnableCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesEnableCall) Do ¶
func (c *ServicesEnableCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "servicemanagement.services.enable" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesEnableCall) Fields ¶
func (c *ServicesEnableCall) Fields(s ...googleapi.Field) *ServicesEnableCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesGenerateConfigReportCall ¶
type ServicesGenerateConfigReportCall struct {
// contains filtered or unexported fields
}
func (*ServicesGenerateConfigReportCall) Context ¶
func (c *ServicesGenerateConfigReportCall) Context(ctx context.Context) *ServicesGenerateConfigReportCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesGenerateConfigReportCall) Do ¶
func (c *ServicesGenerateConfigReportCall) Do(opts ...googleapi.CallOption) (*GenerateConfigReportResponse, error)
Do executes the "servicemanagement.services.generateConfigReport" call. Exactly one of *GenerateConfigReportResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GenerateConfigReportResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesGenerateConfigReportCall) Fields ¶
func (c *ServicesGenerateConfigReportCall) Fields(s ...googleapi.Field) *ServicesGenerateConfigReportCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesGetCall ¶
type ServicesGetCall struct {
// contains filtered or unexported fields
}
func (*ServicesGetCall) Context ¶
func (c *ServicesGetCall) Context(ctx context.Context) *ServicesGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesGetCall) Do ¶
func (c *ServicesGetCall) Do(opts ...googleapi.CallOption) (*ManagedService, error)
Do executes the "servicemanagement.services.get" call. Exactly one of *ManagedService or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ManagedService.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesGetCall) Fields ¶
func (c *ServicesGetCall) Fields(s ...googleapi.Field) *ServicesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ServicesGetCall) IfNoneMatch ¶
func (c *ServicesGetCall) IfNoneMatch(entityTag string) *ServicesGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ServicesGetConfigCall ¶
type ServicesGetConfigCall struct {
// contains filtered or unexported fields
}
func (*ServicesGetConfigCall) ConfigId ¶
func (c *ServicesGetConfigCall) ConfigId(configId string) *ServicesGetConfigCall
ConfigId sets the optional parameter "configId":
func (*ServicesGetConfigCall) Context ¶
func (c *ServicesGetConfigCall) Context(ctx context.Context) *ServicesGetConfigCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesGetConfigCall) Do ¶
func (c *ServicesGetConfigCall) Do(opts ...googleapi.CallOption) (*Service, error)
Do executes the "servicemanagement.services.getConfig" call. Exactly one of *Service or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Service.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesGetConfigCall) Fields ¶
func (c *ServicesGetConfigCall) Fields(s ...googleapi.Field) *ServicesGetConfigCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ServicesGetConfigCall) IfNoneMatch ¶
func (c *ServicesGetConfigCall) IfNoneMatch(entityTag string) *ServicesGetConfigCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ServicesGetIamPolicyCall ¶
type ServicesGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ServicesGetIamPolicyCall) Context ¶
func (c *ServicesGetIamPolicyCall) Context(ctx context.Context) *ServicesGetIamPolicyCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesGetIamPolicyCall) Do ¶
func (c *ServicesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "servicemanagement.services.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesGetIamPolicyCall) Fields ¶
func (c *ServicesGetIamPolicyCall) Fields(s ...googleapi.Field) *ServicesGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesListCall ¶
type ServicesListCall struct {
// contains filtered or unexported fields
}
func (*ServicesListCall) Context ¶
func (c *ServicesListCall) Context(ctx context.Context) *ServicesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesListCall) Do ¶
func (c *ServicesListCall) Do(opts ...googleapi.CallOption) (*ListServicesResponse, error)
Do executes the "servicemanagement.services.list" call. Exactly one of *ListServicesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListServicesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesListCall) Fields ¶
func (c *ServicesListCall) Fields(s ...googleapi.Field) *ServicesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ServicesListCall) IfNoneMatch ¶
func (c *ServicesListCall) IfNoneMatch(entityTag string) *ServicesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ServicesListCall) PageSize ¶
func (c *ServicesListCall) PageSize(pageSize int64) *ServicesListCall
PageSize sets the optional parameter "pageSize": Requested size of the next page of data.
func (*ServicesListCall) PageToken ¶
func (c *ServicesListCall) PageToken(pageToken string) *ServicesListCall
PageToken sets the optional parameter "pageToken": Token identifying which result to start with; returned by a previous list call.
func (*ServicesListCall) Pages ¶
func (c *ServicesListCall) Pages(ctx context.Context, f func(*ListServicesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ServicesListCall) ProducerProjectId ¶
func (c *ServicesListCall) ProducerProjectId(producerProjectId string) *ServicesListCall
ProducerProjectId sets the optional parameter "producerProjectId": Include services produced by the specified project.
type ServicesRolloutsCreateCall ¶
type ServicesRolloutsCreateCall struct {
// contains filtered or unexported fields
}
func (*ServicesRolloutsCreateCall) Context ¶
func (c *ServicesRolloutsCreateCall) Context(ctx context.Context) *ServicesRolloutsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesRolloutsCreateCall) Do ¶
func (c *ServicesRolloutsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "servicemanagement.services.rollouts.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesRolloutsCreateCall) Fields ¶
func (c *ServicesRolloutsCreateCall) Fields(s ...googleapi.Field) *ServicesRolloutsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesRolloutsGetCall ¶
type ServicesRolloutsGetCall struct {
// contains filtered or unexported fields
}
func (*ServicesRolloutsGetCall) Context ¶
func (c *ServicesRolloutsGetCall) Context(ctx context.Context) *ServicesRolloutsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesRolloutsGetCall) Do ¶
func (c *ServicesRolloutsGetCall) Do(opts ...googleapi.CallOption) (*Rollout, error)
Do executes the "servicemanagement.services.rollouts.get" call. Exactly one of *Rollout or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Rollout.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesRolloutsGetCall) Fields ¶
func (c *ServicesRolloutsGetCall) Fields(s ...googleapi.Field) *ServicesRolloutsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ServicesRolloutsGetCall) IfNoneMatch ¶
func (c *ServicesRolloutsGetCall) IfNoneMatch(entityTag string) *ServicesRolloutsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ServicesRolloutsListCall ¶
type ServicesRolloutsListCall struct {
// contains filtered or unexported fields
}
func (*ServicesRolloutsListCall) Context ¶
func (c *ServicesRolloutsListCall) Context(ctx context.Context) *ServicesRolloutsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesRolloutsListCall) Do ¶
func (c *ServicesRolloutsListCall) Do(opts ...googleapi.CallOption) (*ListServiceRolloutsResponse, error)
Do executes the "servicemanagement.services.rollouts.list" call. Exactly one of *ListServiceRolloutsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListServiceRolloutsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesRolloutsListCall) Fields ¶
func (c *ServicesRolloutsListCall) Fields(s ...googleapi.Field) *ServicesRolloutsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ServicesRolloutsListCall) IfNoneMatch ¶
func (c *ServicesRolloutsListCall) IfNoneMatch(entityTag string) *ServicesRolloutsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ServicesRolloutsListCall) PageSize ¶
func (c *ServicesRolloutsListCall) PageSize(pageSize int64) *ServicesRolloutsListCall
PageSize sets the optional parameter "pageSize": The max number of items to include in the response list.
func (*ServicesRolloutsListCall) PageToken ¶
func (c *ServicesRolloutsListCall) PageToken(pageToken string) *ServicesRolloutsListCall
PageToken sets the optional parameter "pageToken": The token of the page to retrieve.
func (*ServicesRolloutsListCall) Pages ¶
func (c *ServicesRolloutsListCall) Pages(ctx context.Context, f func(*ListServiceRolloutsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ServicesRolloutsService ¶
type ServicesRolloutsService struct {
// contains filtered or unexported fields
}
func NewServicesRolloutsService ¶
func NewServicesRolloutsService(s *APIService) *ServicesRolloutsService
func (*ServicesRolloutsService) Create ¶
func (r *ServicesRolloutsService) Create(serviceName string, rollout *Rollout) *ServicesRolloutsCreateCall
Create: Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.
Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.
Operation<response: Rollout>
func (*ServicesRolloutsService) Get ¶
func (r *ServicesRolloutsService) Get(serviceName string, rolloutId string) *ServicesRolloutsGetCall
Get: Gets a service configuration rollout.
func (*ServicesRolloutsService) List ¶
func (r *ServicesRolloutsService) List(serviceName string) *ServicesRolloutsListCall
List: Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
type ServicesService ¶
type ServicesService struct { Configs *ServicesConfigsService Rollouts *ServicesRolloutsService // contains filtered or unexported fields }
func NewServicesService ¶
func NewServicesService(s *APIService) *ServicesService
func (*ServicesService) Create ¶
func (r *ServicesService) Create(managedservice *ManagedService) *ServicesCreateCall
Create: Creates a new managed service. Please note one producer project can own no more than 20 services.
Operation<response: ManagedService>
func (*ServicesService) Delete ¶
func (r *ServicesService) Delete(serviceName string) *ServicesDeleteCall
Delete: Deletes a managed service. This method will change the serivce in the `Soft-Delete` state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted.
Operation<response: google.protobuf.Empty>
func (*ServicesService) Disable ¶
func (r *ServicesService) Disable(serviceName string, disableservicerequest *DisableServiceRequest) *ServicesDisableCall
Disable: Disable a managed service for a project.
Operation<response: DisableServiceResponse>
func (*ServicesService) Enable ¶
func (r *ServicesService) Enable(serviceName string, enableservicerequest *EnableServiceRequest) *ServicesEnableCall
Enable: Enable a managed service for a project with default setting.
Operation<response: EnableServiceResponse>
google.rpc.Status errors may contain a google.rpc.PreconditionFailure error detail.
func (*ServicesService) GenerateConfigReport ¶
func (r *ServicesService) GenerateConfigReport(generateconfigreportrequest *GenerateConfigReportRequest) *ServicesGenerateConfigReportCall
GenerateConfigReport: Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value
If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.
func (*ServicesService) Get ¶
func (r *ServicesService) Get(serviceName string) *ServicesGetCall
Get: Gets a managed service.
func (*ServicesService) GetConfig ¶
func (r *ServicesService) GetConfig(serviceName string) *ServicesGetConfigCall
GetConfig: Gets a service configuration (version) for a managed service.
func (*ServicesService) GetIamPolicy ¶
func (r *ServicesService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ServicesGetIamPolicyCall
GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
func (*ServicesService) List ¶
func (r *ServicesService) List() *ServicesListCall
List: Lists all managed services.
func (*ServicesService) SetIamPolicy ¶
func (r *ServicesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ServicesSetIamPolicyCall
SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy.
func (*ServicesService) TestIamPermissions ¶
func (r *ServicesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ServicesTestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on the specified resource.
func (*ServicesService) Undelete ¶
func (r *ServicesService) Undelete(serviceName string) *ServicesUndeleteCall
Undelete: Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.
Operation<response: UndeleteServiceResponse>
type ServicesSetIamPolicyCall ¶
type ServicesSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ServicesSetIamPolicyCall) Context ¶
func (c *ServicesSetIamPolicyCall) Context(ctx context.Context) *ServicesSetIamPolicyCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesSetIamPolicyCall) Do ¶
func (c *ServicesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "servicemanagement.services.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesSetIamPolicyCall) Fields ¶
func (c *ServicesSetIamPolicyCall) Fields(s ...googleapi.Field) *ServicesSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesTestIamPermissionsCall ¶
type ServicesTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*ServicesTestIamPermissionsCall) Context ¶
func (c *ServicesTestIamPermissionsCall) Context(ctx context.Context) *ServicesTestIamPermissionsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesTestIamPermissionsCall) Do ¶
func (c *ServicesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
Do executes the "servicemanagement.services.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesTestIamPermissionsCall) Fields ¶
func (c *ServicesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ServicesTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ServicesUndeleteCall ¶
type ServicesUndeleteCall struct {
// contains filtered or unexported fields
}
func (*ServicesUndeleteCall) Context ¶
func (c *ServicesUndeleteCall) Context(ctx context.Context) *ServicesUndeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ServicesUndeleteCall) Do ¶
func (c *ServicesUndeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "servicemanagement.services.undelete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ServicesUndeleteCall) Fields ¶
func (c *ServicesUndeleteCall) Fields(s ...googleapi.Field) *ServicesUndeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type SetIamPolicyRequest ¶
type SetIamPolicyRequest struct { // Policy: REQUIRED: The complete policy to be applied to the // `resource`. The size of // the policy is limited to a few 10s of KB. An empty policy is a // valid policy but certain Cloud Platform services (such as // Projects) // might reject them. Policy *Policy `json:"policy,omitempty"` // ForceSendFields is a list of field names (e.g. "Policy") 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. "Policy") 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:"-"` }
SetIamPolicyRequest: Request message for `SetIamPolicy` method.
func (*SetIamPolicyRequest) MarshalJSON ¶
func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)
type SourceContext ¶
type SourceContext struct { // FileName: The path-qualified name of the .proto file that contained // the associated // protobuf element. For example: // "google/protobuf/source_context.proto". FileName string `json:"fileName,omitempty"` // ForceSendFields is a list of field names (e.g. "FileName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FileName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SourceContext: `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.
func (*SourceContext) MarshalJSON ¶
func (s *SourceContext) MarshalJSON() ([]byte, error)
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There will // be a // common set of message types for APIs to use. Details []StatusDetails `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any // user-facing error message should be localized and sent in // the // google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:
- 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, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions.
Language mapping ¶
The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in 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 variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the
partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting purpose.
- Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response,
one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronous operation
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 ¶
type StatusDetails ¶
type StatusDetails interface{}
type Step ¶
type Step struct { // Description: The short description of the step. Description string `json:"description,omitempty"` // Status: The status code. // // Possible values: // "STATUS_UNSPECIFIED" - Unspecifed code. // "DONE" - The step has completed without errors. // "NOT_STARTED" - The step has not started yet. // "IN_PROGRESS" - The step is in progress. // "FAILED" - The step has completed with errors. // "CANCELLED" - The step has completed with cancellation. Status string `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 ¶
type SubmitConfigSourceRequest ¶
type SubmitConfigSourceRequest struct { // ConfigSource: The source configuration for the service. ConfigSource *ConfigSource `json:"configSource,omitempty"` // ValidateOnly: Optional. If set, this will result in the generation of // a // `google.api.Service` configuration based on the `ConfigSource` // provided, // but the generated config and the sources will NOT be persisted. ValidateOnly bool `json:"validateOnly,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfigSource") 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. "ConfigSource") 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:"-"` }
SubmitConfigSourceRequest: Request message for SubmitConfigSource method.
func (*SubmitConfigSourceRequest) MarshalJSON ¶
func (s *SubmitConfigSourceRequest) MarshalJSON() ([]byte, error)
type SubmitConfigSourceResponse ¶
type SubmitConfigSourceResponse struct { // ServiceConfig: The generated service configuration. ServiceConfig *Service `json:"serviceConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "ServiceConfig") 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. "ServiceConfig") 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:"-"` }
SubmitConfigSourceResponse: Response message for SubmitConfigSource method.
func (*SubmitConfigSourceResponse) MarshalJSON ¶
func (s *SubmitConfigSourceResponse) MarshalJSON() ([]byte, error)
type SystemParameter ¶
type SystemParameter struct { // HttpHeader: Define the HTTP header name to use for the parameter. It // is case // insensitive. HttpHeader string `json:"httpHeader,omitempty"` // Name: Define the name of the parameter, such as "api_key", "alt", // "callback", // and etc. It is case sensitive. Name string `json:"name,omitempty"` // UrlQueryParameter: Define the URL query parameter name to use for the // parameter. It is case // sensitive. UrlQueryParameter string `json:"urlQueryParameter,omitempty"` // ForceSendFields is a list of field names (e.g. "HttpHeader") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "HttpHeader") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SystemParameter: Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.
func (*SystemParameter) MarshalJSON ¶
func (s *SystemParameter) MarshalJSON() ([]byte, error)
type SystemParameterRule ¶
type SystemParameterRule struct { // Parameters: Define parameters. Multiple names may be defined for a // parameter. // For a given method call, only one of them should be used. If // multiple // names are used the behavior is implementation-dependent. // If none of the specified names are present the behavior // is // parameter-dependent. Parameters []*SystemParameter `json:"parameters,omitempty"` // Selector: Selects the methods to which this rule applies. Use '*' to // indicate all // methods in all APIs. // // Refer to selector for syntax details. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. "Parameters") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Parameters") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SystemParameterRule: Define a system parameter rule mapping system parameter definitions to methods.
func (*SystemParameterRule) MarshalJSON ¶
func (s *SystemParameterRule) MarshalJSON() ([]byte, error)
type SystemParameters ¶
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 and alt name for all // methods // // system_parameters // rules: // - selector: "*" // parameters: // - name: api_key // url_query_parameter: api_key // - name: alt // http_header: Response-Content-Type // // Example: define 2 api key names for a specific // method. // // system_parameters // rules: // - selector: "/ListShelves" // parameters: // - name: api_key // http_header: Api-Key1 // - name: api_key // http_header: Api-Key2 // // **NOTE:** All service configuration rules follow "last one wins" // order. Rules []*SystemParameterRule `json:"rules,omitempty"` // ForceSendFields is a list of field names (e.g. "Rules") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Rules") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SystemParameters: ### System parameter configuration
A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.
func (*SystemParameters) MarshalJSON ¶
func (s *SystemParameters) MarshalJSON() ([]byte, error)
type TestIamPermissionsRequest ¶
type TestIamPermissionsRequest struct { // Permissions: The set of permissions to check for the `resource`. // Permissions with // wildcards (such as '*' or 'storage.*') are not allowed. For // more // information see // [IAM // Overview](https://cloud.google.com/iam/docs/overview#permissions). Permissions []string `json:"permissions,omitempty"` // ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"` }
TestIamPermissionsRequest: Request message for `TestIamPermissions` method.
func (*TestIamPermissionsRequest) MarshalJSON ¶
func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)
type TestIamPermissionsResponse ¶
type TestIamPermissionsResponse struct { // Permissions: A subset of `TestPermissionsRequest.permissions` that // the caller is // allowed. Permissions []string `json:"permissions,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"` }
TestIamPermissionsResponse: Response message for `TestIamPermissions` method.
func (*TestIamPermissionsResponse) MarshalJSON ¶
func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)
type TrafficPercentStrategy ¶
type TrafficPercentStrategy struct { // Percentages: Maps service configuration IDs to their corresponding // traffic percentage. // Key is the service configuration ID, Value is the traffic // percentage // which must be greater than 0.0 and the sum must equal to 100.0. Percentages map[string]float64 `json:"percentages,omitempty"` // ForceSendFields is a list of field names (e.g. "Percentages") 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. "Percentages") 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:"-"` }
TrafficPercentStrategy: Strategy that specifies how Google Service Control should select different versions of service configurations based on traffic percentage.
One example of how to gradually rollout a new service configuration using this strategy: Day 1
Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } }
Day 2
Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } }
func (*TrafficPercentStrategy) MarshalJSON ¶
func (s *TrafficPercentStrategy) MarshalJSON() ([]byte, error)
type Type ¶
type Type struct { // Fields: The list of fields. Fields []*Field `json:"fields,omitempty"` // Name: The fully qualified message name. Name string `json:"name,omitempty"` // Oneofs: The list of types appearing in `oneof` definitions in this // type. Oneofs []string `json:"oneofs,omitempty"` // Options: The protocol buffer options. Options []*Option `json:"options,omitempty"` // SourceContext: The source context. SourceContext *SourceContext `json:"sourceContext,omitempty"` // Syntax: The source syntax. // // Possible values: // "SYNTAX_PROTO2" - Syntax `proto2`. // "SYNTAX_PROTO3" - Syntax `proto3`. Syntax string `json:"syntax,omitempty"` // ForceSendFields is a list of field names (e.g. "Fields") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Fields") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Type: A protocol buffer message type.
func (*Type) MarshalJSON ¶
type UndeleteServiceResponse ¶
type UndeleteServiceResponse struct { // Service: Revived service resource. Service *ManagedService `json:"service,omitempty"` // ForceSendFields is a list of field names (e.g. "Service") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Service") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
UndeleteServiceResponse: Response message for UndeleteService method.
func (*UndeleteServiceResponse) MarshalJSON ¶
func (s *UndeleteServiceResponse) MarshalJSON() ([]byte, error)
type Usage ¶
type Usage struct { // 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. "Requirements") 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. "Requirements") 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 ¶
type UsageRule ¶
type UsageRule struct { // AllowUnregisteredCalls: True, if the method allows unregistered // calls; false otherwise. AllowUnregisteredCalls bool `json:"allowUnregisteredCalls,omitempty"` // Selector: Selects the methods to which this rule applies. Use '*' to // indicate all // methods in all APIs. // // Refer to selector for syntax details. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. // "AllowUnregisteredCalls") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AllowUnregisteredCalls") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
UsageRule: Usage configuration rules for the service.
NOTE: Under development.
Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls.
Example of an API that wants to allow unregistered calls for entire service.
usage: rules: - selector: "*" allow_unregistered_calls: true
Example of a method that wants to allow unregistered calls.
usage: rules: - selector:
"google.example.library.v1.LibraryService.CreateBook"
allow_unregistered_calls: true
func (*UsageRule) MarshalJSON ¶
type Visibility ¶
type Visibility struct { // Rules: A list of visibility rules that apply to individual API // elements. // // **NOTE:** All service configuration rules follow "last one wins" // order. Rules []*VisibilityRule `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:"-"` }
Visibility: `Visibility` defines restrictions for the visibility of service elements. Restrictions are specified using visibility labels (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
Users and projects can have access to more than one visibility label. The effective visibility for multiple labels is the union of each label's elements, plus any unrestricted elements.
If an element and its parents have no restrictions, visibility is unconditionally granted.
Example:
visibility: rules: - selector: google.calendar.Calendar.EnhancedSearch restriction: TRUSTED_TESTER - selector: google.calendar.Calendar.Delegate restriction: GOOGLE_INTERNAL
Here, all methods are publicly visible except for the restricted methods EnhancedSearch and Delegate.
func (*Visibility) MarshalJSON ¶
func (s *Visibility) MarshalJSON() ([]byte, error)
type VisibilityRule ¶
type VisibilityRule struct { // Restriction: A comma-separated list of visibility labels that apply // to the `selector`. // Any of the listed labels can be used to grant the visibility. // // If a rule has multiple labels, removing one of the labels but not all // of // them can break clients. // // Example: // // visibility: // rules: // - selector: google.calendar.Calendar.EnhancedSearch // restriction: GOOGLE_INTERNAL, TRUSTED_TESTER // // Removing GOOGLE_INTERNAL from this restriction will break clients // that // rely on this method and only had access to it through // GOOGLE_INTERNAL. Restriction string `json:"restriction,omitempty"` // Selector: Selects methods, messages, fields, enums, etc. to which // this rule applies. // // Refer to selector for syntax details. Selector string `json:"selector,omitempty"` // ForceSendFields is a list of field names (e.g. "Restriction") 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. "Restriction") 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:"-"` }
VisibilityRule: A visibility rule provides visibility configuration for an individual API element.
func (*VisibilityRule) MarshalJSON ¶
func (s *VisibilityRule) MarshalJSON() ([]byte, error)