Movatterモバイル変換


[0]ホーム

URL:


apigateway

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package apigateway provides access to the API Gateway API.

For product documentation, see:https://cloud.google.com/api-gateway/docs

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/apigateway/v1beta"...ctx := context.Background()apigatewayService, err := apigateway.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

apigatewayService, err := apigateway.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

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

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeApigatewayApi

type ApigatewayApi struct {// CreateTime: Output only. Created time.CreateTimestring `json:"createTime,omitempty"`// DisplayName: Optional. Display name.DisplayNamestring `json:"displayName,omitempty"`// Labels: Optional. Resource labels to represent user-provided metadata. Refer// to cloud documentation on labels for more details.//https://cloud.google.com/compute/docs/labeling-resourcesLabels map[string]string `json:"labels,omitempty"`// ManagedService: Optional. Immutable. The name of a Google Managed Service (//https://cloud.google.com/service-infrastructure/docs/glossary#managed). If// not specified, a new Service will automatically be created in the same// project as this API.ManagedServicestring `json:"managedService,omitempty"`// Name: Output only. Resource name of the API. Format:// projects/{project}/locations/global/apis/{api}Namestring `json:"name,omitempty"`// State: Output only. State of the API.//// Possible values://   "STATE_UNSPECIFIED" - API does not have a state yet.//   "CREATING" - API is being created.//   "ACTIVE" - API is active.//   "FAILED" - API creation failed.//   "DELETING" - API is being deleted.//   "UPDATING" - API is being updated.Statestring `json:"state,omitempty"`// UpdateTime: Output only. Updated time.UpdateTimestring `json:"updateTime,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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayApi: An API that can be served by one or more Gateways.

func (ApigatewayApi)MarshalJSON

func (sApigatewayApi) MarshalJSON() ([]byte,error)

typeApigatewayApiConfig

type ApigatewayApiConfig struct {// CreateTime: Output only. Created time.CreateTimestring `json:"createTime,omitempty"`// DisplayName: Optional. Display name.DisplayNamestring `json:"displayName,omitempty"`// GatewayConfig: Immutable. Gateway specific configuration.GatewayConfig *ApigatewayGatewayConfig `json:"gatewayConfig,omitempty"`// GatewayServiceAccount: Immutable. The Google Cloud IAM Service Account that// Gateways serving this config should use to authenticate to other services.// This may either be the Service Account's email// (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource name// (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used when// the service is a GCP resource such as a Cloud Run Service or an IAP-secured// service.GatewayServiceAccountstring `json:"gatewayServiceAccount,omitempty"`// GrpcServices: Optional. gRPC service definition files. If specified,// openapi_documents must not be included.GrpcServices []*ApigatewayApiConfigGrpcServiceDefinition `json:"grpcServices,omitempty"`// Labels: Optional. Resource labels to represent user-provided metadata. Refer// to cloud documentation on labels for more details.//https://cloud.google.com/compute/docs/labeling-resourcesLabels map[string]string `json:"labels,omitempty"`// ManagedServiceConfigs: Optional. Service Configuration files. At least one// must be included when using gRPC service definitions. See//https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview// for the expected file contents. If multiple files are specified, the files// are merged with the following rules: * All singular scalar fields are merged// using "last one wins" semantics in the order of the files uploaded. *// Repeated fields are concatenated. * Singular embedded messages are merged// using these rules for nested fields.ManagedServiceConfigs []*ApigatewayApiConfigFile `json:"managedServiceConfigs,omitempty"`// Name: Output only. Resource name of the API Config. Format:// projects/{project}/locations/global/apis/{api}/configs/{api_config}Namestring `json:"name,omitempty"`// OpenapiDocuments: Optional. OpenAPI specification documents. If specified,// grpc_services and managed_service_configs must not be included.OpenapiDocuments []*ApigatewayApiConfigOpenApiDocument `json:"openapiDocuments,omitempty"`// ServiceConfigId: Output only. The ID of the associated Service Config (//https://cloud.google.com/service-infrastructure/docs/glossary#config).ServiceConfigIdstring `json:"serviceConfigId,omitempty"`// State: Output only. State of the API Config.//// Possible values://   "STATE_UNSPECIFIED" - API Config does not have a state yet.//   "CREATING" - API Config is being created and deployed to the API// Controller.//   "ACTIVE" - API Config is ready for use by Gateways.//   "FAILED" - API Config creation failed.//   "DELETING" - API Config is being deleted.//   "UPDATING" - API Config is being updated.//   "ACTIVATING" - API Config settings are being activated in downstream// systems. API Configs in this state cannot be used by Gateways.Statestring `json:"state,omitempty"`// UpdateTime: Output only. Updated time.UpdateTimestring `json:"updateTime,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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayApiConfig: An API Configuration is a combination of settings forboth the Managed Service and Gateways serving this API Config.

func (ApigatewayApiConfig)MarshalJSON

func (sApigatewayApiConfig) MarshalJSON() ([]byte,error)

typeApigatewayApiConfigFile

type ApigatewayApiConfigFile struct {// Contents: The bytes that constitute the file.Contentsstring `json:"contents,omitempty"`// Path: The file path (full or relative path). This is typically the path of// the file when it is uploaded.Pathstring `json:"path,omitempty"`// ForceSendFields is a list of field names (e.g. "Contents") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Contents") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayApiConfigFile: A lightweight description of a file.

func (ApigatewayApiConfigFile)MarshalJSON

func (sApigatewayApiConfigFile) MarshalJSON() ([]byte,error)

typeApigatewayApiConfigGrpcServiceDefinition

type ApigatewayApiConfigGrpcServiceDefinition struct {// FileDescriptorSet: Input only. File descriptor set, 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.pbFileDescriptorSet *ApigatewayApiConfigFile `json:"fileDescriptorSet,omitempty"`// Source: Optional. Uncompiled proto files associated with the descriptor set,// used for display purposes (server-side compilation is not supported). These// should match the inputs to 'protoc' command used to generate// file_descriptor_set.Source []*ApigatewayApiConfigFile `json:"source,omitempty"`// ForceSendFields is a list of field names (e.g. "FileDescriptorSet") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FileDescriptorSet") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayApiConfigGrpcServiceDefinition: A gRPC service definition.

func (ApigatewayApiConfigGrpcServiceDefinition)MarshalJSON

typeApigatewayApiConfigOpenApiDocument

type ApigatewayApiConfigOpenApiDocument struct {// Document: The OpenAPI Specification document file.Document *ApigatewayApiConfigFile `json:"document,omitempty"`// ForceSendFields is a list of field names (e.g. "Document") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Document") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayApiConfigOpenApiDocument: An OpenAPI Specification Documentdescribing an API.

func (ApigatewayApiConfigOpenApiDocument)MarshalJSON

typeApigatewayAuditConfig

type ApigatewayAuditConfig struct {// AuditLogConfigs: The configuration for logging of each type of permission.AuditLogConfigs []*ApigatewayAuditLogConfig `json:"auditLogConfigs,omitempty"`// Service: Specifies a service that will be enabled for audit logging. For// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`// is a special value that covers all services.Servicestring `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AuditLogConfigs") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayAuditConfig: Specifies the audit configuration for a service. Theconfiguration determines which permission types are logged, and whatidentities, if any, are exempted from logging. An AuditConfig must have oneor more AuditLogConfigs. If there are AuditConfigs for both `allServices`and a specific service, the union of the two AuditConfigs is used for thatservice: the log_types specified in each AuditConfig are enabled, and theexempted_members in each AuditLogConfig are exempted. Example Policy withmultiple AuditConfigs: { "audit_configs": [ { "service": "allServices","audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": ["user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type":"ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com","audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type":"DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } Forsampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READlogging. It also exempts `jose@example.com` from DATA_READ logging, and`aliya@example.com` from DATA_WRITE logging.

func (ApigatewayAuditConfig)MarshalJSON

func (sApigatewayAuditConfig) MarshalJSON() ([]byte,error)

typeApigatewayAuditLogConfig

type ApigatewayAuditLogConfig struct {// ExemptedMembers: Specifies the identities that do not cause logging for this// type of permission. Follows the same format of Binding.members.ExemptedMembers []string `json:"exemptedMembers,omitempty"`// LogType: The log type that this config enables.//// Possible values://   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create//   "DATA_READ" - Data reads. Example: CloudSQL Users listLogTypestring `json:"logType,omitempty"`// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExemptedMembers") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayAuditLogConfig: Provides the configuration for logging a type ofpermissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ","exempted_members": [ "user:jose@example.com" ] }, { "log_type":"DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, whileexempting jose@example.com from DATA_READ logging.

func (ApigatewayAuditLogConfig)MarshalJSON

func (sApigatewayAuditLogConfig) MarshalJSON() ([]byte,error)

typeApigatewayBackendConfig

type ApigatewayBackendConfig struct {// GoogleServiceAccount: Google Cloud IAM service account used to sign OIDC// tokens for backends that have authentication configured// (https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest/v1/services.configs#backend).// This may either be the Service Account's email (i.e.// "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name// (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used// when the backend is a GCP resource such as a Cloud Run Service or an// IAP-secured service. Note that this token is always sent as an authorization// header bearer token. The audience of the OIDC token is configured in the// associated Service Config in the BackendRule option// (https://github.com/googleapis/googleapis/blob/master/google/api/backend.proto#L125).GoogleServiceAccountstring `json:"googleServiceAccount,omitempty"`// ForceSendFields is a list of field names (e.g. "GoogleServiceAccount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GoogleServiceAccount") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayBackendConfig: Configuration for all backends.

func (ApigatewayBackendConfig)MarshalJSON

func (sApigatewayBackendConfig) MarshalJSON() ([]byte,error)

typeApigatewayBinding

type ApigatewayBinding struct {// Condition: The condition that is associated with this binding. If the// condition evaluates to `true`, then this binding applies to the current// request. If the condition evaluates to `false`, then this binding does not// apply to the current request. However, a different role binding might grant// the same role to one or more of the principals in this binding. To learn// which resources support conditions in their IAM policies, see the IAM// documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Condition *ApigatewayExpr `json:"condition,omitempty"`// Members: Specifies the principals requesting access for a Google Cloud// 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. Does not include identities that come from external identity// providers (IdPs) through identity federation. * `user:{emailid}`: An email// address that represents a specific Google account. For example,// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that// represents a Google service account. For example,// `my-other-app@appspot.gserviceaccount.com`. *// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An// identifier for a Kubernetes service account// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *// `group:{emailid}`: An email address that represents a Google group. For// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain// (primary) that represents all the users of that domain. For example,// `google.com` or `example.com`. *// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub// ject/{subject_attribute_value}`: A single identity in a workforce identity// pool. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// group/{group_id}`: All workforce identities in a group. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// attribute.{attribute_name}/{attribute_value}`: All workforce identities with// a specific attribute value. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// *`: All identities in a workforce identity pool. *// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single// identity in a workload identity pool. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool// group. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}// `: All identities in a workload identity pool with a certain attribute. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a user that has been recently deleted. For// example, `alice@example.com?uid=123456789012345678901`. If the user is// recovered, this value reverts to `user:{emailid}` and the recovered user// retains the role in the binding. *// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a service account that has been recently// deleted. For example,// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the// service account is undeleted, this value reverts to// `serviceAccount:{emailid}` and the undeleted service account retains the// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email// address (plus unique identifier) representing a Google group that has been// recently deleted. For example,// `admins@example.com?uid=123456789012345678901`. If the group is recovered,// this value reverts to `group:{emailid}` and the recovered group retains the// role in the binding. *// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool// _id}/subject/{subject_attribute_value}`: Deleted single identity in a// workforce identity pool. For example,// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po// ol-id/subject/my-subject-attribute-value`.Members []string `json:"members,omitempty"`// Role: Role that is assigned to the list of `members`, or principals. For// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview// of the IAM roles and permissions, see the IAM documentation// (https://cloud.google.com/iam/docs/roles-overview). For a list of the// available pre-defined roles, see here// (https://cloud.google.com/iam/docs/understanding-roles).Rolestring `json:"role,omitempty"`// ForceSendFields is a list of field names (e.g. "Condition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Condition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayBinding: Associates `members`, or principals, with a `role`.

func (ApigatewayBinding)MarshalJSON

func (sApigatewayBinding) MarshalJSON() ([]byte,error)

typeApigatewayCancelOperationRequest

type ApigatewayCancelOperationRequest struct {}

ApigatewayCancelOperationRequest: The request message forOperations.CancelOperation.

typeApigatewayExpr

type ApigatewayExpr struct {// Description: Optional. Description of the expression. This is a longer text// which describes the expression, e.g. when hovered over it in a UI.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in Common Expression// Language syntax.Expressionstring `json:"expression,omitempty"`// Location: Optional. String indicating the location of the expression for// error reporting, e.g. a file name and a position in the file.Locationstring `json:"location,omitempty"`// Title: Optional. Title for the expression, i.e. a short string describing// its purpose. This can be used e.g. in UIs which allow to enter the// expression.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayExpr: Represents a textual expression in the Common ExpressionLanguage (CEL) syntax. CEL is a C-like expression language. The syntax andsemantics of CEL are documented athttps://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determinesif a summary is less than 100 chars" expression: "document.summary.size() <100" Example (Equality): title: "Requestor is owner" description:"Determines if requestor is the document owner" expression: "document.owner== request.auth.claims.email" Example (Logic): title: "Public documents"description: "Determine whether the document should be publicly visible"expression: "document.type != 'private' && document.type != 'internal'"Example (Data Manipulation): title: "Notification string" description:"Create a notification string with a timestamp." expression: "'New messagereceived at ' + string(document.create_time)" The exact variables andfunctions that may be referenced within an expression are determined by theservice that evaluates it. See the service documentation for additionalinformation.

func (ApigatewayExpr)MarshalJSON

func (sApigatewayExpr) MarshalJSON() ([]byte,error)

typeApigatewayGateway

type ApigatewayGateway struct {// ApiConfig: Required. Resource name of the API Config for this Gateway.// Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}ApiConfigstring `json:"apiConfig,omitempty"`// CreateTime: Output only. Created time.CreateTimestring `json:"createTime,omitempty"`// DefaultHostname: Output only. The default API Gateway host name of the form// `{gateway_id}-{hash}.{region_code}.gateway.dev`.DefaultHostnamestring `json:"defaultHostname,omitempty"`// DisplayName: Optional. Display name.DisplayNamestring `json:"displayName,omitempty"`// Labels: Optional. Resource labels to represent user-provided metadata. Refer// to cloud documentation on labels for more details.//https://cloud.google.com/compute/docs/labeling-resourcesLabels map[string]string `json:"labels,omitempty"`// Name: Output only. Resource name of the Gateway. Format:// projects/{project}/locations/{location}/gateways/{gateway}Namestring `json:"name,omitempty"`// State: Output only. The current state of the Gateway.//// Possible values://   "STATE_UNSPECIFIED" - Gateway does not have a state yet.//   "CREATING" - Gateway is being created.//   "ACTIVE" - Gateway is running and ready for requests.//   "FAILED" - Gateway creation failed.//   "DELETING" - Gateway is being deleted.//   "UPDATING" - Gateway is being updated.Statestring `json:"state,omitempty"`// UpdateTime: Output only. Updated time.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ApiConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ApiConfig") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayGateway: A Gateway is an API-aware HTTP proxy. It performsAPI-Method and/or API-Consumer specific actions based on an API Config suchas authentication, policy enforcement, and backend selection.

func (ApigatewayGateway)MarshalJSON

func (sApigatewayGateway) MarshalJSON() ([]byte,error)

typeApigatewayGatewayConfig

type ApigatewayGatewayConfig struct {// BackendConfig: Required. Backend settings that are applied to all backends// of the Gateway.BackendConfig *ApigatewayBackendConfig `json:"backendConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "BackendConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackendConfig") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayGatewayConfig: Configuration settings for Gateways.

func (ApigatewayGatewayConfig)MarshalJSON

func (sApigatewayGatewayConfig) MarshalJSON() ([]byte,error)

typeApigatewayListApiConfigsResponse

type ApigatewayListApiConfigsResponse struct {// ApiConfigs: API Configs.ApiConfigs []*ApigatewayApiConfig `json:"apiConfigs,omitempty"`// NextPageToken: Next page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// UnreachableLocations: Locations that could not be reached.UnreachableLocations []string `json:"unreachableLocations,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ApiConfigs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ApiConfigs") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayListApiConfigsResponse: Response message forApiGatewayService.ListApiConfigs

func (ApigatewayListApiConfigsResponse)MarshalJSON

func (sApigatewayListApiConfigsResponse) MarshalJSON() ([]byte,error)

typeApigatewayListApisResponse

type ApigatewayListApisResponse struct {// Apis: APIs.Apis []*ApigatewayApi `json:"apis,omitempty"`// NextPageToken: Next page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// UnreachableLocations: Locations that could not be reached.UnreachableLocations []string `json:"unreachableLocations,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Apis") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Apis") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayListApisResponse: Response message for ApiGatewayService.ListApis

func (ApigatewayListApisResponse)MarshalJSON

func (sApigatewayListApisResponse) MarshalJSON() ([]byte,error)

typeApigatewayListGatewaysResponse

type ApigatewayListGatewaysResponse struct {// Gateways: Gateways.Gateways []*ApigatewayGateway `json:"gateways,omitempty"`// NextPageToken: Next page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// UnreachableLocations: Locations that could not be reached.UnreachableLocations []string `json:"unreachableLocations,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Gateways") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Gateways") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayListGatewaysResponse: Response message forApiGatewayService.ListGateways

func (ApigatewayListGatewaysResponse)MarshalJSON

func (sApigatewayListGatewaysResponse) MarshalJSON() ([]byte,error)

typeApigatewayListLocationsResponse

type ApigatewayListLocationsResponse struct {// Locations: A list of locations that matches the specified filter in the// request.Locations []*ApigatewayLocation `json:"locations,omitempty"`// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Locations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Locations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayListLocationsResponse: The response message forLocations.ListLocations.

func (ApigatewayListLocationsResponse)MarshalJSON

func (sApigatewayListLocationsResponse) MarshalJSON() ([]byte,error)

typeApigatewayListOperationsResponse

type ApigatewayListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*ApigatewayOperation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections e.g. when attempting to list all resources across all supported// locations.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayListOperationsResponse: The response message forOperations.ListOperations.

func (ApigatewayListOperationsResponse)MarshalJSON

func (sApigatewayListOperationsResponse) MarshalJSON() ([]byte,error)

typeApigatewayLocation

type ApigatewayLocation struct {// DisplayName: The friendly name for this location, typically a nearby city// name. For example, "Tokyo".DisplayNamestring `json:"displayName,omitempty"`// Labels: Cross-service attributes for the location. For example// {"cloud.googleapis.com/region": "us-east1"}Labels map[string]string `json:"labels,omitempty"`// LocationId: The canonical id for this location. For example: "us-east1".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available capacity at// the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayLocation: A resource that represents a Google Cloud location.

func (ApigatewayLocation)MarshalJSON

func (sApigatewayLocation) MarshalJSON() ([]byte,error)

typeApigatewayOperation

type ApigatewayOperation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *ApigatewayStatus `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayOperation: This resource represents a long-running operation thatis the result of a network API call.

func (ApigatewayOperation)MarshalJSON

func (sApigatewayOperation) MarshalJSON() ([]byte,error)

typeApigatewayOperationMetadata

type ApigatewayOperationMetadata struct {// ApiVersion: Output only. API version used to start the operation.ApiVersionstring `json:"apiVersion,omitempty"`// CreateTime: Output only. The time the operation was created.CreateTimestring `json:"createTime,omitempty"`// Diagnostics: Output only. Diagnostics generated during processing of// configuration source files.Diagnostics []*ApigatewayOperationMetadataDiagnostic `json:"diagnostics,omitempty"`// EndTime: Output only. The time the operation finished running.EndTimestring `json:"endTime,omitempty"`// RequestedCancellation: Output only. Identifies whether the user has// requested cancellation of the operation. Operations that have successfully// been cancelled have google.longrunning.Operation.error value with a// google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.RequestedCancellationbool `json:"requestedCancellation,omitempty"`// StatusMessage: Output only. Human-readable status of the operation, if any.StatusMessagestring `json:"statusMessage,omitempty"`// Target: Output only. Server-defined resource path for the target of the// operation.Targetstring `json:"target,omitempty"`// Verb: Output only. Name of the verb executed by the operation.Verbstring `json:"verb,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ApiVersion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayOperationMetadata: Represents the metadata of the long-runningoperation.

func (ApigatewayOperationMetadata)MarshalJSON

func (sApigatewayOperationMetadata) MarshalJSON() ([]byte,error)

typeApigatewayOperationMetadataDiagnostic

type ApigatewayOperationMetadataDiagnostic struct {// Location: Location of the diagnostic.Locationstring `json:"location,omitempty"`// Message: The diagnostic message.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Location") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Location") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayOperationMetadataDiagnostic: Diagnostic information fromconfiguration processing.

func (ApigatewayOperationMetadataDiagnostic)MarshalJSON

typeApigatewayPolicy

type ApigatewayPolicy struct {// AuditConfigs: Specifies cloud audit logging configuration for this policy.AuditConfigs []*ApigatewayAuditConfig `json:"auditConfigs,omitempty"`// Bindings: Associates a list of `members`, or principals, with a `role`.// Optionally, may specify a `condition` that determines how and when the// `bindings` are applied. Each of the `bindings` must contain at least one// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;// up to 250 of these principals can be Google groups. Each occurrence of a// principal counts towards these limits. For example, if the `bindings` grant// 50 different roles to `user:alice@example.com`, and not to any other// principal, then you can add another 1,450 principals to the `bindings` in// the `Policy`.Bindings []*ApigatewayBinding `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.// **Important:** If you use IAM Conditions, you must include the `etag` field// whenever you call `setIamPolicy`. If you omit this field, then IAM allows// you to overwrite a version `3` policy with a version `1` policy, and all of// the conditions in the version `3` policy are lost.Etagstring `json:"etag,omitempty"`// Version: Specifies the format of the policy. Valid values are `0`, `1`, and// `3`. Requests that specify an invalid value are rejected. Any operation that// affects conditional role bindings must specify version `3`. This requirement// applies to the following operations: * Getting a policy that includes a// conditional role binding * Adding a conditional role binding to a policy *// Changing a conditional role binding in a policy * Removing any role binding,// with or without a condition, from a policy that includes conditions// **Important:** If you use IAM Conditions, you must include the `etag` field// whenever you call `setIamPolicy`. If you omit this field, then IAM allows// you to overwrite a version `3` policy with a version `1` policy, and all of// the conditions in the version `3` policy are lost. If a policy does not// include any conditions, operations on that policy may specify any valid// version or leave the field unset. To learn which resources support// conditions in their IAM policies, see the IAM documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Versionint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AuditConfigs") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayPolicy: An Identity and Access Management (IAM) policy, whichspecifies access controls for Google Cloud resources. A `Policy` is acollection of `bindings`. A `binding` binds one or more `members`, orprincipals, to a single `role`. Principals can be user accounts, serviceaccounts, Google groups, and domains (such as G Suite). A `role` is a namedlist of permissions; each `role` can be an IAM predefined role or auser-created custom role. For some types of Google Cloud resources, a`binding` can also specify a `condition`, which is a logical expression thatallows access to a resource only if the expression evaluates to `true`. Acondition can add constraints based on attributes of the request, theresource, or both. To learn which resources support conditions in their IAMpolicies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies). **JSONexample:** ``` { "bindings": [ { "role":"roles/resourcemanager.organizationAdmin", "members": ["user:mike@example.com", "group:admins@example.com", "domain:google.com","serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role":"roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com" ], "condition": { "title": "expirable access","description": "Does not grant access after Sep 2020", "expression":"request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag":"BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: -members: - user:mike@example.com - group:admins@example.com -domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.comrole: roles/resourcemanager.organizationAdmin - members: -user:eve@example.com role: roles/resourcemanager.organizationViewercondition: title: expirable access description: Does not grant access afterSep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features,see the IAM documentation (https://cloud.google.com/iam/docs/).

func (ApigatewayPolicy)MarshalJSON

func (sApigatewayPolicy) MarshalJSON() ([]byte,error)

typeApigatewaySetIamPolicyRequest

type ApigatewaySetIamPolicyRequest 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 Google Cloud services (such as Projects) might reject// them.Policy *ApigatewayPolicy `json:"policy,omitempty"`// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to// modify. Only the fields in the mask will be modified. If no mask is// provided, the following default mask is used: `paths: "bindings, etag"UpdateMaskstring `json:"updateMask,omitempty"`// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Policy") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewaySetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (ApigatewaySetIamPolicyRequest)MarshalJSON

func (sApigatewaySetIamPolicyRequest) MarshalJSON() ([]byte,error)

typeApigatewayStatus

type ApigatewayStatus struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayStatus: The `Status` type defines a logical error model that issuitable for different programming environments, including REST APIs and RPCAPIs. It is used by gRPC (https://github.com/grpc). Each `Status` messagecontains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in theAPI Design Guide (https://cloud.google.com/apis/design/errors).

func (ApigatewayStatus)MarshalJSON

func (sApigatewayStatus) MarshalJSON() ([]byte,error)

typeApigatewayTestIamPermissionsRequest

type ApigatewayTestIamPermissionsRequest 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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Permissions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayTestIamPermissionsRequest: Request message for`TestIamPermissions` method.

func (ApigatewayTestIamPermissionsRequest)MarshalJSON

typeApigatewayTestIamPermissionsResponse

type ApigatewayTestIamPermissionsResponse 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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Permissions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ApigatewayTestIamPermissionsResponse: Response message for`TestIamPermissions` method.

func (ApigatewayTestIamPermissionsResponse)MarshalJSON

typeEmpty

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

Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeProjectsLocationsApisConfigsCreateCall

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

func (*ProjectsLocationsApisConfigsCreateCall)ApiConfigId

ApiConfigId sets the optional parameter "apiConfigId": Required. Identifierto assign to the API Config. Must be unique within scope of the parentresource.

func (*ProjectsLocationsApisConfigsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisConfigsCreateCall)Do

Do executes the "apigateway.projects.locations.apis.configs.create" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisConfigsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisConfigsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsApisConfigsDeleteCall

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

func (*ProjectsLocationsApisConfigsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisConfigsDeleteCall)Do

Do executes the "apigateway.projects.locations.apis.configs.delete" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisConfigsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisConfigsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsApisConfigsGetCall

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

func (*ProjectsLocationsApisConfigsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisConfigsGetCall)Do

Do executes the "apigateway.projects.locations.apis.configs.get" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayApiConfig.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisConfigsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisConfigsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsApisConfigsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsApisConfigsGetCall)View

View sets the optional parameter "view": Specifies which fields of the APIConfig are returned in the response. Defaults to `BASIC` view.

Possible values:

"CONFIG_VIEW_UNSPECIFIED""BASIC" - Do not include configuration source files."FULL" - Include configuration source files.

typeProjectsLocationsApisConfigsGetIamPolicyCall

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

func (*ProjectsLocationsApisConfigsGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisConfigsGetIamPolicyCall)Do

Do executes the "apigateway.projects.locations.apis.configs.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayPolicy.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisConfigsGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisConfigsGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsApisConfigsGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsApisConfigsGetIamPolicyCall)OptionsRequestedPolicyVersion

func (c *ProjectsLocationsApisConfigsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ProjectsLocationsApisConfigsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsApisConfigsListCall

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

func (*ProjectsLocationsApisConfigsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisConfigsListCall)Do

Do executes the "apigateway.projects.locations.apis.configs.list" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayListApiConfigsResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsApisConfigsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisConfigsListCall)Filter

Filter sets the optional parameter "filter": Filter.

func (*ProjectsLocationsApisConfigsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsApisConfigsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsApisConfigsListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Order by parameters.

func (*ProjectsLocationsApisConfigsListCall)PageSize

PageSize sets the optional parameter "pageSize": Page size.

func (*ProjectsLocationsApisConfigsListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token.

func (*ProjectsLocationsApisConfigsListCall)Pages

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.

typeProjectsLocationsApisConfigsPatchCall

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

func (*ProjectsLocationsApisConfigsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisConfigsPatchCall)Do

Do executes the "apigateway.projects.locations.apis.configs.patch" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisConfigsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisConfigsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsApisConfigsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used tospecify the fields to be overwritten in the ApiConfig resource by theupdate. The fields specified in the update_mask are relative to theresource, not the full request. A field will be overwritten if it is in themask. If the user does not provide a mask then all fields will beoverwritten.

typeProjectsLocationsApisConfigsService

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

func (*ProjectsLocationsApisConfigsService)Create

Create: Creates a new ApiConfig in a given project and location.

  • parent: Parent resource of the API Config, of the form:`projects/*/locations/global/apis/*`.

func (*ProjectsLocationsApisConfigsService)Delete

Delete: Deletes a single ApiConfig.

  • name: Resource name of the form:`projects/*/locations/global/apis/*/configs/*`.

func (*ProjectsLocationsApisConfigsService)Get

Get: Gets details of a single ApiConfig.

  • name: Resource name of the form:`projects/*/locations/global/apis/*/configs/*`.

func (*ProjectsLocationsApisConfigsService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsApisConfigsService)List

List: Lists ApiConfigs in a given project and location.

  • parent: Parent resource of the API Config, of the form:`projects/*/locations/global/apis/*`.

func (*ProjectsLocationsApisConfigsService)Patch

Patch: Updates the parameters of a single ApiConfig.

  • name: Output only. Resource name of the API Config. Format:projects/{project}/locations/global/apis/{api}/configs/{api_config}.

func (*ProjectsLocationsApisConfigsService)SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsApisConfigsService)TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsApisConfigsSetIamPolicyCall

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

func (*ProjectsLocationsApisConfigsSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisConfigsSetIamPolicyCall)Do

Do executes the "apigateway.projects.locations.apis.configs.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayPolicy.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisConfigsSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisConfigsSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsApisConfigsTestIamPermissionsCall

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

func (*ProjectsLocationsApisConfigsTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisConfigsTestIamPermissionsCall)Do

Do executes the "apigateway.projects.locations.apis.configs.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayTestIamPermissionsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsApisConfigsTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisConfigsTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsApisCreateCall

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

func (*ProjectsLocationsApisCreateCall)ApiId

ApiId sets the optional parameter "apiId": Required. Identifier to assign tothe API. Must be unique within scope of the parent resource.

func (*ProjectsLocationsApisCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisCreateCall)Do

Do executes the "apigateway.projects.locations.apis.create" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsApisDeleteCall

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

func (*ProjectsLocationsApisDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisDeleteCall)Do

Do executes the "apigateway.projects.locations.apis.delete" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsApisGetCall

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

func (*ProjectsLocationsApisGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisGetCall)Do

Do executes the "apigateway.projects.locations.apis.get" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayApi.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsApisGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsApisGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsApisGetIamPolicyCall

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

func (*ProjectsLocationsApisGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisGetIamPolicyCall)Do

Do executes the "apigateway.projects.locations.apis.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayPolicy.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsApisGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsApisGetIamPolicyCall)OptionsRequestedPolicyVersion

func (c *ProjectsLocationsApisGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ProjectsLocationsApisGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsApisListCall

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

func (*ProjectsLocationsApisListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisListCall)Do

Do executes the "apigateway.projects.locations.apis.list" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayListApisResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsApisListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisListCall)Filter

Filter sets the optional parameter "filter": Filter.

func (*ProjectsLocationsApisListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsApisListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsApisListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Order by parameters.

func (*ProjectsLocationsApisListCall)PageSize

PageSize sets the optional parameter "pageSize": Page size.

func (*ProjectsLocationsApisListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token.

func (*ProjectsLocationsApisListCall)Pages

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.

typeProjectsLocationsApisPatchCall

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

func (*ProjectsLocationsApisPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisPatchCall)Do

Do executes the "apigateway.projects.locations.apis.patch" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsApisPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used tospecify the fields to be overwritten in the Api resource by the update. Thefields specified in the update_mask are relative to the resource, not thefull request. A field will be overwritten if it is in the mask. If the userdoes not provide a mask then all fields will be overwritten.

typeProjectsLocationsApisService

type ProjectsLocationsApisService struct {Configs *ProjectsLocationsApisConfigsService// contains filtered or unexported fields}

funcNewProjectsLocationsApisService

func NewProjectsLocationsApisService(s *Service) *ProjectsLocationsApisService

func (*ProjectsLocationsApisService)Create

Create: Creates a new Api in a given project and location.

  • parent: Parent resource of the API, of the form:`projects/*/locations/global`.

func (*ProjectsLocationsApisService)Delete

Delete: Deletes a single Api.

- name: Resource name of the form: `projects/*/locations/global/apis/*`.

func (*ProjectsLocationsApisService)Get

Get: Gets details of a single Api.

- name: Resource name of the form: `projects/*/locations/global/apis/*`.

func (*ProjectsLocationsApisService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsApisService)List

List: Lists Apis in a given project and location.

  • parent: Parent resource of the API, of the form:`projects/*/locations/global`.

func (*ProjectsLocationsApisService)Patch

Patch: Updates the parameters of a single Api.

  • name: Output only. Resource name of the API. Format:projects/{project}/locations/global/apis/{api}.

func (*ProjectsLocationsApisService)SetIamPolicy

func (r *ProjectsLocationsApisService) SetIamPolicy(resourcestring, apigatewaysetiampolicyrequest *ApigatewaySetIamPolicyRequest) *ProjectsLocationsApisSetIamPolicyCall

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsApisService)TestIamPermissions

func (r *ProjectsLocationsApisService) TestIamPermissions(resourcestring, apigatewaytestiampermissionsrequest *ApigatewayTestIamPermissionsRequest) *ProjectsLocationsApisTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsApisSetIamPolicyCall

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

func (*ProjectsLocationsApisSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisSetIamPolicyCall)Do

Do executes the "apigateway.projects.locations.apis.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayPolicy.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsApisSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsApisTestIamPermissionsCall

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

func (*ProjectsLocationsApisTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsApisTestIamPermissionsCall)Do

Do executes the "apigateway.projects.locations.apis.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayTestIamPermissionsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsApisTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsApisTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsGatewaysCreateCall

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

func (*ProjectsLocationsGatewaysCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGatewaysCreateCall)Do

Do executes the "apigateway.projects.locations.gateways.create" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsGatewaysCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGatewaysCreateCall)GatewayId

GatewayId sets the optional parameter "gatewayId": Required. Identifier toassign to the Gateway. Must be unique within scope of the parent resource.

func (*ProjectsLocationsGatewaysCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsGatewaysDeleteCall

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

func (*ProjectsLocationsGatewaysDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGatewaysDeleteCall)Do

Do executes the "apigateway.projects.locations.gateways.delete" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsGatewaysDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGatewaysDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsGatewaysGetCall

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

func (*ProjectsLocationsGatewaysGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGatewaysGetCall)Do

Do executes the "apigateway.projects.locations.gateways.get" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayGateway.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsGatewaysGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGatewaysGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGatewaysGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsGatewaysGetIamPolicyCall

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

func (*ProjectsLocationsGatewaysGetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGatewaysGetIamPolicyCall)Do

Do executes the "apigateway.projects.locations.gateways.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayPolicy.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsGatewaysGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGatewaysGetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGatewaysGetIamPolicyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsGatewaysGetIamPolicyCall)OptionsRequestedPolicyVersion

func (c *ProjectsLocationsGatewaysGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ProjectsLocationsGatewaysGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsGatewaysListCall

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

func (*ProjectsLocationsGatewaysListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGatewaysListCall)Do

Do executes the "apigateway.projects.locations.gateways.list" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayListGatewaysResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsGatewaysListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGatewaysListCall)Filter

Filter sets the optional parameter "filter": Filter.

func (*ProjectsLocationsGatewaysListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGatewaysListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsGatewaysListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Order by parameters.

func (*ProjectsLocationsGatewaysListCall)PageSize

PageSize sets the optional parameter "pageSize": Page size.

func (*ProjectsLocationsGatewaysListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token.

func (*ProjectsLocationsGatewaysListCall)Pages

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.

typeProjectsLocationsGatewaysPatchCall

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

func (*ProjectsLocationsGatewaysPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGatewaysPatchCall)Do

Do executes the "apigateway.projects.locations.gateways.patch" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsGatewaysPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGatewaysPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGatewaysPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used tospecify the fields to be overwritten in the Gateway resource by the update.The fields specified in the update_mask are relative to the resource, notthe full request. A field will be overwritten if it is in the mask. If theuser does not provide a mask then all fields will be overwritten.

typeProjectsLocationsGatewaysService

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

funcNewProjectsLocationsGatewaysService

func NewProjectsLocationsGatewaysService(s *Service) *ProjectsLocationsGatewaysService

func (*ProjectsLocationsGatewaysService)Create

Create: Creates a new Gateway in a given project and location.

  • parent: Parent resource of the Gateway, of the form:`projects/*/locations/*`.

func (*ProjectsLocationsGatewaysService)Delete

Delete: Deletes a single Gateway.

- name: Resource name of the form: `projects/*/locations/*/gateways/*`.

func (*ProjectsLocationsGatewaysService)Get

Get: Gets details of a single Gateway.

- name: Resource name of the form: `projects/*/locations/*/gateways/*`.

func (*ProjectsLocationsGatewaysService)GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns anempty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsGatewaysService)List

List: Lists Gateways in a given project and location.

  • parent: Parent resource of the Gateway, of the form:`projects/*/locations/*`.

func (*ProjectsLocationsGatewaysService)Patch

Patch: Updates the parameters of a single Gateway.

  • name: Output only. Resource name of the Gateway. Format:projects/{project}/locations/{location}/gateways/{gateway}.

func (*ProjectsLocationsGatewaysService)SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource.Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`,and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsGatewaysService)TestIamPermissions

func (r *ProjectsLocationsGatewaysService) TestIamPermissions(resourcestring, apigatewaytestiampermissionsrequest *ApigatewayTestIamPermissionsRequest) *ProjectsLocationsGatewaysTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specifiedresource. If the resource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsGatewaysSetIamPolicyCall

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

func (*ProjectsLocationsGatewaysSetIamPolicyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGatewaysSetIamPolicyCall)Do

Do executes the "apigateway.projects.locations.gateways.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayPolicy.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsGatewaysSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGatewaysSetIamPolicyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsGatewaysTestIamPermissionsCall

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

func (*ProjectsLocationsGatewaysTestIamPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGatewaysTestIamPermissionsCall)Do

Do executes the "apigateway.projects.locations.gateways.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayTestIamPermissionsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsGatewaysTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGatewaysTestIamPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall)Do

Do executes the "apigateway.projects.locations.get" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayLocation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsListCall

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

func (*ProjectsLocationsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall)Do

Do executes the "apigateway.projects.locations.list" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayListLocationsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsListCall)ExtraLocationTypesadded inv0.230.0

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do notuse this field. It is unsupported and is ignored unless explicitlydocumented otherwise. This is primarily for internal usage.

func (*ProjectsLocationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsListCall)Filter

Filter sets the optional parameter "filter": A filter to narrow down resultsto a preferred subset. The filtering language accepts strings like"displayName=tokyo", and is documented in more detail in AIP-160(https://google.aip.dev/160).

func (*ProjectsLocationsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token receivedfrom the `next_page_token` field in the response. Send that page token toreceive the subsequent page.

func (*ProjectsLocationsListCall)Pages

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.

typeProjectsLocationsOperationsCancelCall

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

func (*ProjectsLocationsOperationsCancelCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall)Do

Do executes the "apigateway.projects.locations.operations.cancel" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsCancelCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsOperationsDeleteCall

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

func (*ProjectsLocationsOperationsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall)Do

Do executes the "apigateway.projects.locations.operations.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall)Do

Do executes the "apigateway.projects.locations.operations.get" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayOperation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall)Do

Do executes the "apigateway.projects.locations.operations.list" call.Any non-2xx status code is an error. Response headers are in either*ApigatewayListOperationsResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsListCall)Filter

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

func (*ProjectsLocationsOperationsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsOperationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall)PageSize

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

func (*ProjectsLocationsOperationsListCall)PageToken

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

func (*ProjectsLocationsOperationsListCall)Pages

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 (*ProjectsLocationsOperationsListCall)ReturnPartialSuccessadded inv0.253.0

func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in the[ListOperationsResponse.unreachable] field. This can only be `true` whenreading across collections e.g. when `parent` is set to"projects/example/locations/-". This field is not by default supported andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsLocationsOperationsService

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

func (*ProjectsLocationsOperationsService)Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. Theserver makes a best effort to cancel the operation, but success is notguaranteed. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation orother methods to check whether the cancellation succeeded or whether theoperation completed despite cancellation. On successful cancellation, theoperation is not deleted; instead, it becomes an operation with anOperation.error value with a google.rpc.Status.code of `1`, corresponding to`Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService)Delete

Delete: Deletes a long-running operation. This method indicates that theclient is no longer interested in the operation result. It does not cancelthe operation. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService)Get

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService)List

List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

typeProjectsLocationsService

type ProjectsLocationsService struct {Apis *ProjectsLocationsApisServiceGateways *ProjectsLocationsGatewaysServiceOperations *ProjectsLocationsOperationsService// contains filtered or unexported fields}

funcNewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService)Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService)List

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

typeProjectsService

type ProjectsService struct {Locations *ProjectsLocationsService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

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

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewService

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

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp