google-api-ruby-client/generated/google-apis-apigateway_v1beta/lib/google/apis/apigateway_v1beta/classes.rb

1171 lines
52 KiB
Ruby

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ApigatewayV1beta
# An API that can be served by one or more Gateways.
class ApigatewayApi
include Google::Apis::Core::Hashable
# Output only. Created time.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Optional. Display name.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Optional. Resource labels to represent user-provided metadata. Refer to cloud
# documentation on labels for more details. https://cloud.google.com/compute/
# docs/labeling-resources
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# 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.
# Corresponds to the JSON property `managedService`
# @return [String]
attr_accessor :managed_service
# Output only. Resource name of the API. Format: projects/`project`/locations/
# global/apis/`api`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Output only. State of the API.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Output only. Updated time.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@display_name = args[:display_name] if args.key?(:display_name)
@labels = args[:labels] if args.key?(:labels)
@managed_service = args[:managed_service] if args.key?(:managed_service)
@name = args[:name] if args.key?(:name)
@state = args[:state] if args.key?(:state)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# An API Configuration is a combination of settings for both the Managed Service
# and Gateways serving this API Config.
class ApigatewayApiConfig
include Google::Apis::Core::Hashable
# Output only. Created time.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Optional. Display name.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Configuration settings for Gateways.
# Corresponds to the JSON property `gatewayConfig`
# @return [Google::Apis::ApigatewayV1beta::ApigatewayGatewayConfig]
attr_accessor :gateway_config
# 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.
# Corresponds to the JSON property `gatewayServiceAccount`
# @return [String]
attr_accessor :gateway_service_account
# Optional. gRPC service definition files. If specified, openapi_documents must
# not be included.
# Corresponds to the JSON property `grpcServices`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayApiConfigGrpcServiceDefinition>]
attr_accessor :grpc_services
# Optional. Resource labels to represent user-provided metadata. Refer to cloud
# documentation on labels for more details. https://cloud.google.com/compute/
# docs/labeling-resources
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# 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.
# Corresponds to the JSON property `managedServiceConfigs`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile>]
attr_accessor :managed_service_configs
# Output only. Resource name of the API Config. Format: projects/`project`/
# locations/global/apis/`api`/configs/`api_config`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Optional. OpenAPI specification documents. If specified, grpc_services and
# managed_service_configs must not be included.
# Corresponds to the JSON property `openapiDocuments`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayApiConfigOpenApiDocument>]
attr_accessor :openapi_documents
# Output only. The ID of the associated Service Config ( https://cloud.google.
# com/service-infrastructure/docs/glossary#config).
# Corresponds to the JSON property `serviceConfigId`
# @return [String]
attr_accessor :service_config_id
# Output only. State of the API Config.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Output only. Updated time.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@display_name = args[:display_name] if args.key?(:display_name)
@gateway_config = args[:gateway_config] if args.key?(:gateway_config)
@gateway_service_account = args[:gateway_service_account] if args.key?(:gateway_service_account)
@grpc_services = args[:grpc_services] if args.key?(:grpc_services)
@labels = args[:labels] if args.key?(:labels)
@managed_service_configs = args[:managed_service_configs] if args.key?(:managed_service_configs)
@name = args[:name] if args.key?(:name)
@openapi_documents = args[:openapi_documents] if args.key?(:openapi_documents)
@service_config_id = args[:service_config_id] if args.key?(:service_config_id)
@state = args[:state] if args.key?(:state)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# A lightweight description of a file.
class ApigatewayApiConfigFile
include Google::Apis::Core::Hashable
# The bytes that constitute the file.
# Corresponds to the JSON property `contents`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :contents
# The file path (full or relative path). This is typically the path of the file
# when it is uploaded.
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@contents = args[:contents] if args.key?(:contents)
@path = args[:path] if args.key?(:path)
end
end
# A gRPC service definition.
class ApigatewayApiConfigGrpcServiceDefinition
include Google::Apis::Core::Hashable
# A lightweight description of a file.
# Corresponds to the JSON property `fileDescriptorSet`
# @return [Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile]
attr_accessor :file_descriptor_set
# 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.
# Corresponds to the JSON property `source`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile>]
attr_accessor :source
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@file_descriptor_set = args[:file_descriptor_set] if args.key?(:file_descriptor_set)
@source = args[:source] if args.key?(:source)
end
end
# An OpenAPI Specification Document describing an API.
class ApigatewayApiConfigOpenApiDocument
include Google::Apis::Core::Hashable
# A lightweight description of a file.
# Corresponds to the JSON property `document`
# @return [Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile]
attr_accessor :document
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@document = args[:document] if args.key?(:document)
end
end
# Specifies the audit configuration for a service. The configuration determines
# which permission types are logged, and what identities, if any, are exempted
# from logging. An AuditConfig must have one or more AuditLogConfigs. If there
# are AuditConfigs for both `allServices` and a specific service, the union of
# the two AuditConfigs is used for that service: the log_types specified in each
# AuditConfig are enabled, and the exempted_members in each AuditLogConfig are
# exempted. Example Policy with multiple 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" ] ` ] ` ] ` For sampleservice,
# this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also
# exempts jose@example.com from DATA_READ logging, and aliya@example.com from
# DATA_WRITE logging.
class ApigatewayAuditConfig
include Google::Apis::Core::Hashable
# The configuration for logging of each type of permission.
# Corresponds to the JSON property `auditLogConfigs`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayAuditLogConfig>]
attr_accessor :audit_log_configs
# 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.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs)
@service = args[:service] if args.key?(:service)
end
end
# Provides the configuration for logging a type of permissions. 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, while exempting jose@example.com from
# DATA_READ logging.
class ApigatewayAuditLogConfig
include Google::Apis::Core::Hashable
# Specifies the identities that do not cause logging for this type of permission.
# Follows the same format of Binding.members.
# Corresponds to the JSON property `exemptedMembers`
# @return [Array<String>]
attr_accessor :exempted_members
# The log type that this config enables.
# Corresponds to the JSON property `logType`
# @return [String]
attr_accessor :log_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@exempted_members = args[:exempted_members] if args.key?(:exempted_members)
@log_type = args[:log_type] if args.key?(:log_type)
end
end
# Configuration for all backends.
class ApigatewayBackendConfig
include Google::Apis::Core::Hashable
# 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).
# Corresponds to the JSON property `googleServiceAccount`
# @return [String]
attr_accessor :google_service_account
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@google_service_account = args[:google_service_account] if args.key?(:google_service_account)
end
end
# Associates `members` with a `role`.
class ApigatewayBinding
include Google::Apis::Core::Hashable
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
# "Summary size limit" description: "Determines if 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 message received at ' + string(document.create_time)" The
# exact variables and functions that may be referenced within an expression are
# determined by the service that evaluates it. See the service documentation for
# additional information.
# Corresponds to the JSON property `condition`
# @return [Google::Apis::ApigatewayV1beta::ApigatewayExpr]
attr_accessor :condition
# Specifies the identities requesting access for a Cloud Platform resource. `
# members` can have the following values: * `allUsers`: A special identifier
# that represents anyone who is on the internet; with or without a Google
# account. * `allAuthenticatedUsers`: A special identifier that represents
# anyone who is authenticated with a Google account or a service account. * `
# user:`emailid``: An email address that represents a specific Google account.
# For example, `alice@example.com` . * `serviceAccount:`emailid``: An email
# address that represents a service account. For example, `my-other-app@appspot.
# gserviceaccount.com`. * `group:`emailid``: An email address that represents a
# Google group. For example, `admins@example.com`. * `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. * `domain:`domain``: The G Suite domain (
# primary) that represents all the users of that domain. For example, `google.
# com` or `example.com`.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
# , or `roles/owner`.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@condition = args[:condition] if args.key?(:condition)
@members = args[:members] if args.key?(:members)
@role = args[:role] if args.key?(:role)
end
end
# The request message for Operations.CancelOperation.
class ApigatewayCancelOperationRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
# "Summary size limit" description: "Determines if 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 message received at ' + string(document.create_time)" The
# exact variables and functions that may be referenced within an expression are
# determined by the service that evaluates it. See the service documentation for
# additional information.
class ApigatewayExpr
include Google::Apis::Core::Hashable
# Optional. Description of the expression. This is a longer text which describes
# the expression, e.g. when hovered over it in a UI.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Textual representation of an expression in Common Expression Language syntax.
# Corresponds to the JSON property `expression`
# @return [String]
attr_accessor :expression
# Optional. String indicating the location of the expression for error reporting,
# e.g. a file name and a position in the file.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# 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.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@expression = args[:expression] if args.key?(:expression)
@location = args[:location] if args.key?(:location)
@title = args[:title] if args.key?(:title)
end
end
# A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-
# Consumer specific actions based on an API Config such as authentication,
# policy enforcement, and backend selection.
class ApigatewayGateway
include Google::Apis::Core::Hashable
# Required. Resource name of the API Config for this Gateway. Format: projects/`
# project`/locations/global/apis/`api`/configs/`apiConfig`
# Corresponds to the JSON property `apiConfig`
# @return [String]
attr_accessor :api_config
# Output only. Created time.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Output only. The default API Gateway host name of the form ``gateway_id`-`hash`
# .`region_code`.gateway.dev`.
# Corresponds to the JSON property `defaultHostname`
# @return [String]
attr_accessor :default_hostname
# Optional. Display name.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Optional. Resource labels to represent user-provided metadata. Refer to cloud
# documentation on labels for more details. https://cloud.google.com/compute/
# docs/labeling-resources
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Output only. Resource name of the Gateway. Format: projects/`project`/
# locations/`location`/gateways/`gateway`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Output only. The current state of the Gateway.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Output only. Updated time.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@api_config = args[:api_config] if args.key?(:api_config)
@create_time = args[:create_time] if args.key?(:create_time)
@default_hostname = args[:default_hostname] if args.key?(:default_hostname)
@display_name = args[:display_name] if args.key?(:display_name)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
@state = args[:state] if args.key?(:state)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# Configuration settings for Gateways.
class ApigatewayGatewayConfig
include Google::Apis::Core::Hashable
# Configuration for all backends.
# Corresponds to the JSON property `backendConfig`
# @return [Google::Apis::ApigatewayV1beta::ApigatewayBackendConfig]
attr_accessor :backend_config
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@backend_config = args[:backend_config] if args.key?(:backend_config)
end
end
# Response message for ApiGatewayService.ListApiConfigs
class ApigatewayListApiConfigsResponse
include Google::Apis::Core::Hashable
# API Configs.
# Corresponds to the JSON property `apiConfigs`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayApiConfig>]
attr_accessor :api_configs
# Next page token.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# Locations that could not be reached.
# Corresponds to the JSON property `unreachableLocations`
# @return [Array<String>]
attr_accessor :unreachable_locations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@api_configs = args[:api_configs] if args.key?(:api_configs)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
end
end
# Response message for ApiGatewayService.ListApis
class ApigatewayListApisResponse
include Google::Apis::Core::Hashable
# APIs.
# Corresponds to the JSON property `apis`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayApi>]
attr_accessor :apis
# Next page token.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# Locations that could not be reached.
# Corresponds to the JSON property `unreachableLocations`
# @return [Array<String>]
attr_accessor :unreachable_locations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apis = args[:apis] if args.key?(:apis)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
end
end
# Response message for ApiGatewayService.ListGateways
class ApigatewayListGatewaysResponse
include Google::Apis::Core::Hashable
# Gateways.
# Corresponds to the JSON property `gateways`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayGateway>]
attr_accessor :gateways
# Next page token.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# Locations that could not be reached.
# Corresponds to the JSON property `unreachableLocations`
# @return [Array<String>]
attr_accessor :unreachable_locations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@gateways = args[:gateways] if args.key?(:gateways)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
end
end
# The response message for Locations.ListLocations.
class ApigatewayListLocationsResponse
include Google::Apis::Core::Hashable
# A list of locations that matches the specified filter in the request.
# Corresponds to the JSON property `locations`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayLocation>]
attr_accessor :locations
# The standard List next-page token.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@locations = args[:locations] if args.key?(:locations)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# The response message for Operations.ListOperations.
class ApigatewayListOperationsResponse
include Google::Apis::Core::Hashable
# The standard List next-page token.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# A list of operations that matches the specified filter in the request.
# Corresponds to the JSON property `operations`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayOperation>]
attr_accessor :operations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@operations = args[:operations] if args.key?(:operations)
end
end
# A resource that represents Google Cloud Platform location.
class ApigatewayLocation
include Google::Apis::Core::Hashable
# The friendly name for this location, typically a nearby city name. For example,
# "Tokyo".
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
# region": "us-east1"`
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# The canonical id for this location. For example: `"us-east1"`.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# Service-specific metadata. For example the available capacity at the given
# location.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# Resource name for the location, which may vary between implementations. For
# example: `"projects/example-project/locations/us-east1"`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@labels = args[:labels] if args.key?(:labels)
@location_id = args[:location_id] if args.key?(:location_id)
@metadata = args[:metadata] if args.key?(:metadata)
@name = args[:name] if args.key?(:name)
end
end
# This resource represents a long-running operation that is the result of a
# network API call.
class ApigatewayOperation
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by [
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# data: error code, error message, and error details. You can find out more
# about this error model and how to work with it in the [API Design Guide](https:
# //cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `error`
# @return [Google::Apis::ApigatewayV1beta::ApigatewayStatus]
attr_accessor :error
# 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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# 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``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is `google.
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
# the response should be the resource. For other methods, the response should
# have the type `XxxResponse`, where `Xxx` is the original method name. For
# example, if the original method name is `TakeSnapshot()`, the inferred
# response type is `TakeSnapshotResponse`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@done = args[:done] if args.key?(:done)
@error = args[:error] if args.key?(:error)
@metadata = args[:metadata] if args.key?(:metadata)
@name = args[:name] if args.key?(:name)
@response = args[:response] if args.key?(:response)
end
end
# Represents the metadata of the long-running operation.
class ApigatewayOperationMetadata
include Google::Apis::Core::Hashable
# Output only. API version used to start the operation.
# Corresponds to the JSON property `apiVersion`
# @return [String]
attr_accessor :api_version
# Output only. The time the operation was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Output only. Diagnostics generated during processing of configuration source
# files.
# Corresponds to the JSON property `diagnostics`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayOperationMetadataDiagnostic>]
attr_accessor :diagnostics
# Output only. The time the operation finished running.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Output only. Identifies whether the user has requested cancellation of the
# operation. Operations that have successfully been cancelled have Operation.
# error value with a google.rpc.Status.code of 1, corresponding to `Code.
# CANCELLED`.
# Corresponds to the JSON property `requestedCancellation`
# @return [Boolean]
attr_accessor :requested_cancellation
alias_method :requested_cancellation?, :requested_cancellation
# Output only. Human-readable status of the operation, if any.
# Corresponds to the JSON property `statusMessage`
# @return [String]
attr_accessor :status_message
# Output only. Server-defined resource path for the target of the operation.
# Corresponds to the JSON property `target`
# @return [String]
attr_accessor :target
# Output only. Name of the verb executed by the operation.
# Corresponds to the JSON property `verb`
# @return [String]
attr_accessor :verb
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@api_version = args[:api_version] if args.key?(:api_version)
@create_time = args[:create_time] if args.key?(:create_time)
@diagnostics = args[:diagnostics] if args.key?(:diagnostics)
@end_time = args[:end_time] if args.key?(:end_time)
@requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation)
@status_message = args[:status_message] if args.key?(:status_message)
@target = args[:target] if args.key?(:target)
@verb = args[:verb] if args.key?(:verb)
end
end
# Diagnostic information from configuration processing.
class ApigatewayOperationMetadataDiagnostic
include Google::Apis::Core::Hashable
# Location of the diagnostic.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# The diagnostic message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@location = args[:location] if args.key?(:location)
@message = args[:message] if args.key?(:message)
end
end
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
# A `binding` binds one or more `members` to a single `role`. Members can be
# user accounts, service accounts, Google groups, and domains (such as G Suite).
# A `role` is a named list of permissions; each `role` can be an IAM predefined
# role or a user-created custom role. For some types of Google Cloud resources,
# a `binding` can also specify a `condition`, which is a logical expression that
# allows access to a resource only if the expression evaluates to `true`. A
# condition can add constraints based on attributes of the request, the resource,
# or both. To learn which resources support conditions in their IAM policies,
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
# resource-policies). **JSON example:** ` "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.com role: roles/
# resourcemanager.organizationAdmin - members: - user:eve@example.com role:
# roles/resourcemanager.organizationViewer 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 For a
# description of IAM and its features, see the [IAM documentation](https://cloud.
# google.com/iam/docs/).
class ApigatewayPolicy
include Google::Apis::Core::Hashable
# Specifies cloud audit logging configuration for this policy.
# Corresponds to the JSON property `auditConfigs`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayAuditConfig>]
attr_accessor :audit_configs
# Associates a list of `members` to 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 member.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::ApigatewayV1beta::ApigatewayBinding>]
attr_accessor :bindings
# `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.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
# 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).
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@audit_configs = args[:audit_configs] if args.key?(:audit_configs)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
end
end
# Request message for `SetIamPolicy` method.
class ApigatewaySetIamPolicyRequest
include Google::Apis::Core::Hashable
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
# A `binding` binds one or more `members` to a single `role`. Members can be
# user accounts, service accounts, Google groups, and domains (such as G Suite).
# A `role` is a named list of permissions; each `role` can be an IAM predefined
# role or a user-created custom role. For some types of Google Cloud resources,
# a `binding` can also specify a `condition`, which is a logical expression that
# allows access to a resource only if the expression evaluates to `true`. A
# condition can add constraints based on attributes of the request, the resource,
# or both. To learn which resources support conditions in their IAM policies,
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
# resource-policies). **JSON example:** ` "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.com role: roles/
# resourcemanager.organizationAdmin - members: - user:eve@example.com role:
# roles/resourcemanager.organizationViewer 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 For a
# description of IAM and its features, see the [IAM documentation](https://cloud.
# google.com/iam/docs/).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy]
attr_accessor :policy
# 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"`
# Corresponds to the JSON property `updateMask`
# @return [String]
attr_accessor :update_mask
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@policy = args[:policy] if args.key?(:policy)
@update_mask = args[:update_mask] if args.key?(:update_mask)
end
end
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by [
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# data: error code, error message, and error details. You can find out more
# about this error model and how to work with it in the [API Design Guide](https:
# //cloud.google.com/apis/design/errors).
class ApigatewayStatus
include Google::Apis::Core::Hashable
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# 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.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@details = args[:details] if args.key?(:details)
@message = args[:message] if args.key?(:message)
end
end
# Request message for `TestIamPermissions` method.
class ApigatewayTestIamPermissionsRequest
include Google::Apis::Core::Hashable
# 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).
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# Response message for `TestIamPermissions` method.
class ApigatewayTestIamPermissionsResponse
include Google::Apis::Core::Hashable
# A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
end
end
end